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

fix(docs): docs reference #4869

Merged
merged 1 commit into from
Oct 26, 2023
Merged

fix(docs): docs reference #4869

merged 1 commit into from
Oct 26, 2023

Conversation

JSerFeng
Copy link
Collaborator

@JSerFeng JSerFeng commented Oct 26, 2023

Summary

fix doc references

🤖 Generated by Copilot at a4584d9

This pull request improves the documentation for using Storybook with the builder-doc and main-doc packages. It fixes link issues, enhances readability and accessibility, and adds deprecation warnings for the old version of Storybook. It also adds a changeset file for the @modern-js/main-doc package.

Details

🤖 Generated by Copilot at a4584d9

  • Add a changeset file to indicate a patch release and describe the document reference fix (link)
  • Update the documents for using Storybook to use links instead of plain URLs for the migration guide and absolute URLs instead of relative URLs for the builder config, in both English and Chinese versions (link, link, link, link)
  • Update the documents for the debug mode to use absolute URLs instead of relative URLs for the builder config, in both English and Chinese versions (link, link)
  • Add a warning to the documents for using the old version Storybook V6 and provide a link to the new version Storybook V7, in both English and Chinese versions (using-storybook.mdx files, link, link)

Related Issue

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@changeset-bot
Copy link

changeset-bot bot commented Oct 26, 2023

🦋 Changeset detected

Latest commit: a4584d9

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@chenjiahan
Copy link
Member

related issue: web-infra-dev/rspress#266

@chenjiahan chenjiahan merged commit 4e1fcd7 into main Oct 26, 2023
8 checks passed
@chenjiahan chenjiahan deleted the fix/docs branch October 26, 2023 09:28
@caohuilin caohuilin mentioned this pull request Oct 26, 2023
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