Skip to content

chore: remove links from docs #13425

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

Merged
merged 2 commits into from
Sep 28, 2024
Merged

chore: remove links from docs #13425

merged 2 commits into from
Sep 28, 2024

Conversation

Rich-Harris
Copy link
Member

there's truly no point in doc comments including links to a page that just includes the exact some content. It just creates extra work when generating the docs pages, since we would have to strip out the links (which sometimes have a Docs: prefix and sometimes don't), and it creates the possibility of the links getting stale if we evolve the site structure.

Copy link

changeset-bot bot commented Sep 28, 2024

⚠️ No Changeset found

Latest commit: 590eb66

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@benmccann
Copy link
Member

lgtm except that lint is failing

@Rich-Harris Rich-Harris merged commit d87bf17 into main Sep 28, 2024
8 of 9 checks passed
@Rich-Harris Rich-Harris deleted the remove-links-from-docs branch September 28, 2024 19:34
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