docs: point quick-start dev server links at a heading that exists - #1811
Open
dirnalafeinte wants to merge 1 commit into
Open
docs: point quick-start dev server links at a heading that exists#1811dirnalafeinte wants to merge 1 commit into
dirnalafeinte wants to merge 1 commit into
Conversation
Six quick-start guides link to /docs/local-development#inngest-dev-server. That page has no heading producing an inngest-dev-server id, so the anchor does nothing and readers land at the top of the page. The link text is "start the Inngest Dev Server" in all six, and the section covering that is "Getting started" (#getting-started). The TanStack Start guide also had its query string after the fragment (#inngest-dev-server?ref=...), which makes ?ref= part of the fragment rather than a query parameter. Reordered to ?ref=...#getting-started. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
@dirnalafeinte is attempting to deploy a commit to the Inngest Team on Vercel. A member of the Team first needs to authorize it. |
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
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
Six quick-start guides link to
/docs/local-development#inngest-dev-server. That page has no heading that produces aninngest-dev-serverid, so the anchor resolves to nothing and readers land at the top of the page instead of the section they were sent to.pages/docs/local-development.mdxheadings are:(The other
#lines in that file are shell comments inside code fences, so they get no id.)Slugs come from
mdx/rehype.mjs, which applies@sindresorhus/slugifyto h1–h4 text. None of the above yieldsinngest-dev-server.Changes
In all six guides the link text is "start the Inngest Dev Server", and the section that covers installing the CLI and running
inngest devis## Getting started. Repointed to#getting-started:astro-quick-start.mdxexpress-quick-start.mdxh3-quick-start.mdxnestjs-quick-start.mdxnodejs-quick-start.mdxtanstack-start-quick-start.mdxThe TanStack Start guide additionally had its query string after the fragment:
As written,
?ref=…was part of the fragment, not a query parameter, so therefattribution was silently lost. Reordered.Happy to use a different target if you'd rather add an
inngest-dev-serverheading tolocal-development.mdxinstead — that would work too, and I can switch this PR to that approach.Verification
Wrote a checker that computes each docs page's real anchor set — h1–h4 slugified with the same
slugifyWithCounterthe site uses, plus<Property name>ids and explicitid=attributes — then resolves every fragment link inpages/docs/**/*.mdxagainst it, ignoring code fences and{/* … */}comments.It reports 22 other fragment links that don't resolve, mostly anchors into code-heavy headings where I'm less confident my slug reproduction matches the renderer exactly. I deliberately left those out of this PR rather than guess. If the approach looks useful to you I'm glad to work through them in a follow-up, or share the script.