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: Fix incorrect relative links #28375

Merged
merged 3 commits into from
Jun 28, 2024
Merged

Conversation

kylegach
Copy link
Contributor

What I did

  1. Fix incorrect relative links
    • On a page inside a new directory (e.g. get-started/frameworks), almost* every relative link that went up a level (e.g. ../writing-stories/args.mdx) now needs to go up two levels (e.g. ../../writing-stories/args.mdx).
      • * The exception is relative links pointing to directories that are siblings of the current directory, e.g. on configure/integration, a link to ../user-interface/sidebar.mdx does not need adjusted.
  2. Fix links that were missing new directories
    • e.g. ./api/main-config-typescript.mdx -> ./api/main-config/main-config-typescript.mdx
  3. Replace remaining *.md docs links with *.mdx

Checklist for Contributors

Testing

Tested in docs preview

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

kylegach added 3 commits June 27, 2024 22:22
On a page inside a new directory (e.g. `get-started/frameworks`), almost* every relative link that went up a level (e.g. `../writing-stories/args.mdx`) now needs to go up two levels (e.g. `../../writing-stories/args.mdx`).

* The exception is relative links pointing to directories that are siblings of the current directory, e.g. on `configure/integration`, a link to `../user-interface/sidebar.mdx` does _not_ need adjusted.
e.g. `./api/main-config-typescript.mdx` -> `./api/main-config/main-config-typescript.mdx`
@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Jun 28, 2024
@kylegach kylegach self-assigned this Jun 28, 2024
Copy link

nx-cloud bot commented Jun 28, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit cdde79c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@kylegach kylegach merged commit 5defd98 into next Jun 28, 2024
9 of 10 checks passed
@kylegach kylegach deleted the fix-docs-links-for-migration branch June 28, 2024 04:35
kylegach added a commit that referenced this pull request Jun 28, 2024
kylegach added a commit that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant