26 Commits

Author SHA1 Message Date
Gert Hengeveld
b8cc9c99b6 Update documentation to prefer 'create storybook' over 'storybook init' and clean up CLI reference 2025-02-20 13:21:37 +01:00
Shota FUJI
7a32c16cfd
Docs: Fix broken links ending with ".mdx"
When I checked "How to contribute" page on storybook.js.org, a link
titled "Continue reading our contributor covenant" pointed to GitHub's
404 page. The last item of the URL path was "CODE_OF_CONDUCT.mdx", which
is not common filename people uses, therefore I suspected this is not
the only broken link in the docs.

And I was right. I ran the below command (rg = RipGrep) then found
several 404 links.

```
$ cd docs
$ rg "https?:[\S)]+mdx\)" --sort path
```

Git blame told me that some of ".md" to ".mdx" migration works
accidentally changed non-docs URLs ending with ".md" too.

StackBlitz URL in docs/api/main-config/main-config-indexers.mdx is not
actually a dead link, as the service redirects to the `README.md`.
However, the redirection takes loooong so I replaced that as well.

There are still two links that match to the above regexp:

* <https://github.com/storybookjs/storybook/blob/next/docs/get-started/setup.mdx>
  at docs/contribute/documentation/new-snippets.mdx L42
* <https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx>
  at docs/writing-docs/mdx.mdx

but those two are both valid (alive) URLs.
2024-09-05 15:30:37 +09:00
Kyle Gach
cdde79ce70 Replace remaining *.md docs links with *.mdx 2024-06-27 22:25:39 -06:00
Charles de Dreuille
cbc0a416e2 migration + sharing links 2024-06-18 09:16:28 +01:00
Charles de Dreuille
ea32eb5616 Update from-older-version.mdx 2024-06-14 14:21:47 +01:00
Charles de Dreuille
010d657909 Finish all docs 2024-06-14 08:57:54 +01:00
Charles de Dreuille
c9b9a0929f Updated indexes root 2024-06-13 18:34:00 +01:00
Charles de Dreuille
fdf0856332 Convert code snippets paths into a single path 2024-06-13 17:53:43 +01:00
Charles de Dreuille
41e0a4fca2 Update comments to javascript 2024-06-13 17:52:40 +01:00
Charles de Dreuille
36b38f7283 Rename all file extensions from .md to .mdx 2024-06-13 17:52:12 +01:00
Kyle Gach
877257edda Content tweaks 2024-06-10 11:06:23 -06:00
Michael Shilman
33c4d4905c Document package structure changes across major versions 2024-06-07 12:54:32 +08:00
Joe Vaughan
c2be62fd8d
Update from-older-version.md
updated feature list
2024-03-07 18:46:27 +00:00
Joe Vaughan
9eea0d4a5a
Update index.md
fixed title change
2024-03-07 18:45:40 +00:00
Joe Vaughan
c5503309b9
Docs: update index.md
Changed the feature list
2024-03-07 18:45:17 +00:00
Kyle Gach
4780ae3103 Add section about missing vite config file 2024-03-07 11:12:25 -07:00
Joe Vaughan
3356ca218d
Update index.md 2024-03-07 17:14:48 +00:00
Joe Vaughan
5ee7f99a4d
Update index.md
the links were broken for me when viewing this in production!
2024-03-07 17:13:47 +00:00
Kyle Gach
a5beee8a4c Merge branch 'next' into migration-guide-updates-2
* next: (39 commits)
  Typo
  cleanup
  Add story for empty argTypes and address review
  fix issues with types, change the comment to not be jsdoc
  Add E2E test for multiple CSF files with same title in autodocs
  Fix overflow bug by using a better link
  remove deprecation of `manager-api`'s `types` export
  Don't show empty arg tables in doc pages
  Fix Yarn2Proxy findInstallations method
  revert component values back to array
  done
  perf(manager): improve performance when switching stories
  Add todo comment
  Refactor MDX to CSF transform function to return an object instead of a tuple
  Rename broken MDX files to .mdx.broken
  Upgrade migration-guide to mention limitations of mdx-to-csf codemod
  Fix issues where stories.js files were generated although a story doesn't exist
  Rename transformed mdx files
  Add version range for removeLegacyMDX1 fix
  Fix typo in automigrate/types.ts
  ...
2024-02-27 10:12:36 -07:00
Kyle Gach
5263629a23 Address feedback
- Restructure to more accurately provide `storyStoreV7`, `storiesOf`, and MDX 2 guidance
2024-02-27 10:09:56 -07:00
Kyle Gach
0c44973d91 Further prose tweaks 2024-02-26 12:24:59 -07:00
Kyle Gach
0dab4522a7 Address comments
- Fix typos and small prose improvements
2024-02-26 11:37:09 -07:00
Kyle Gach
7e6efff882 Remove *.stories.mdx manual migration in 6 -> 8
- Per: https://github.com/storybookjs/storybook/pull/26201
2024-02-26 11:32:32 -07:00
Kyle Gach
5853950d14
Apply suggestions from code review
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
2024-02-26 11:32:18 -07:00
Kyle Gach
10b6e17ab8 Update migration guides
- Remove babel breaking change mention
2024-02-26 08:32:30 -07:00
Kyle Gach
a7e41877f8 Update migration guides
- Add 6 to 8 guide
- Account for auto-blockers
2024-02-23 22:41:44 -07:00