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

docs(storybook): seo links #8162

Merged
merged 3 commits into from
Jan 30, 2024
Merged

docs(storybook): seo links #8162

merged 3 commits into from
Jan 30, 2024

Conversation

dobrinyonkov
Copy link
Contributor

@dobrinyonkov dobrinyonkov commented Jan 23, 2024

Semantic links in the tree of stories. Links to the API reference pages are now named by their component name.

E.g Docs -> Avatar Overview

image

In order to achive this, the following changes were made:

  1. The "Docs" pages are no longer automatically generated, because to take control over the namings, the only option is to disable the autodocs mechanism and to generate our own mdx files. (autodocs: 'tag")
  2. docs.tsx is replaced by individual mdx files per component.
  3. Build script overviews-prepare.ts is called before serving the storybook to generate the .mdx files at built time.

@dobrinyonkov dobrinyonkov merged commit 962a2c2 into main Jan 30, 2024
8 checks passed
@dobrinyonkov dobrinyonkov deleted the seo-links branch January 30, 2024 13:23
tsanislavgatev pushed a commit that referenced this pull request Feb 20, 2024
* docs: stroybook seo links

* docs: remove docs.tsx usage

* chore: fix missing new lies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants