Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution Guideline link on Storybook not working #568

Closed
cagatay-usta opened this issue May 5, 2023 · 1 comment
Closed

Contribution Guideline link on Storybook not working #568

cagatay-usta opened this issue May 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@cagatay-usta
Copy link

Describe the bug
As the storybook docs import from README.md, the link refers to './CONTRIBUTING.md' which works on github but on StoryBook it redirects to 'https://baklava.design/CONTRIBUTING.md' which naturally results in 404.

To Reproduce
Steps to reproduce the behavior:

  1. Go to baklava.design
  2. Click on 'For more information please check our [Contribution Guideline document]'
  3. See error

Expected behavior
Ideally the link should refer depending on whether clicked from github or storybook. However as the markdown file is imported directly, I couldn't manage to add that logic without seperating the link between github and storybook docs.

Proposed Solution
Only working solution I could come up without creating the need to update both files seperately is to use absolute paths rather than relative, and have both github and storybook links avaliable:
For more information please check our [Contribution Guideline document on GitHub](https://github.com/Trendyol/baklava/blob/next/CONTRIBUTING.md), or [on Storybook](https://baklava.design/?path=/docs/documentation-contributing-baklava-contribution-guideline--page).

For more information please check our Contribution Guideline document on GitHub, or on Storybook.

Screenshots
404 page:

baklava404

working solution:

baklavaWorkingSolution

@cagatay-usta cagatay-usta changed the title Contribution Guideline link on StoryBook not working Contribution Guideline link on Storybook not working May 5, 2023
@muratcorlu muratcorlu added the documentation Improvements or additions to documentation label May 8, 2023
@muratcorlu muratcorlu moved this from Selected to Ready for Development in Baklava Design System May 8, 2023
@muratcorlu muratcorlu moved this from Ready for Development to In Review in Baklava Design System May 26, 2023
@onurravli
Copy link
Contributor

onurravli commented Sep 8, 2023

Hello, fixed with #684. cc @muratcorlu

@github-project-automation github-project-automation bot moved this from In Review to Done in Baklava Design System Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants