Fix broken anchor links in documentation #2936
Merged
+3
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | `fern generate` | Build & publish SDK updates | | ||
| | `fern write-definition` | Convert OpenAPI specifications to [Fern Definition](/learn/api-definition/fern/overview) | | ||
| | `fern write-overrides` | Create OpenAPI customizations | | ||
| | `fern generator upgrade` | Update SDK generators to latest versions | |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| <Step title="Customize your docs"> | ||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) | ||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'Now' that become outdated
| <Note> | ||
| Section-level changelogs **cannot** be nested within an `api` entry. See [API-level changelogs](#api-level-changelog) to add an API-level entry. | ||
| Section-level changelogs **cannot** be nested within an `api` entry. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.
Contributor
Contributor
Contributor
devalog
approved these changes
Dec 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes broken anchor links across 7 documentation files. These links pointed to headings that don't exist, typically because they referenced Step component titles (which don't generate anchor IDs) or used incorrect numbered suffixes for duplicate headings.
Changes by file:
#oauth-authentication→#auth-scheme-reference#add-namespaces-optional#preview-your-docsand#publish-to-production#api-level-changelog#metadata-2→#metadata-1,#reviewers-4→#reviewers-1,#reviewers-1→#reviewers)#developer-packslinks with external Microsoft download links; removed broken#legacy-projectsreferencesUpdates since last revision
Restored the valid anchor links in commands.mdx that were incorrectly removed. After DOM inspection, I confirmed that Accordion components in this docs platform DO generate anchor IDs from their titles (e.g.,
<Accordion title="fern init">generatesid="fern-init"). The original removal was based on a false assumption.Review & Testing Checklist for Human
fern init,fern generate --docs) and confirm they scroll to the corresponding Accordion section#metadata-1,#reviewers-1) depend on heading orderRecommended test plan: Open the preview deployment and navigate to the commands page first to verify the table links work. Then check generators-yml-reference.mdx for the metadata/reviewers links. Finally, spot-check pages where links were removed to ensure readability.
Notes