Skip to content

docs: point quick-start dev server links at a heading that exists - #1811

Open
dirnalafeinte wants to merge 1 commit into
inngest:mainfrom
dirnalafeinte:docs-fix-dev-server-anchor
Open

docs: point quick-start dev server links at a heading that exists#1811
dirnalafeinte wants to merge 1 commit into
inngest:mainfrom
dirnalafeinte:docs-fix-dev-server-anchor

Conversation

@dirnalafeinte

Copy link
Copy Markdown

Summary

Six quick-start guides link to /docs/local-development#inngest-dev-server. That page has no heading that produces an inngest-dev-server id, 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.mdx headings are:

# Local development
## Getting started
## AI-assisted local development
## Connecting apps to the Dev Server
### How functions are loaded by the Dev Server
## Testing functions
### Invoke via UI
### Sending events to the Dev Server

(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/slugify to h1–h4 text. None of the above yields inngest-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 dev is ## Getting started. Repointed to #getting-started:

  • astro-quick-start.mdx
  • express-quick-start.mdx
  • h3-quick-start.mdx
  • nestjs-quick-start.mdx
  • nodejs-quick-start.mdx
  • tanstack-start-quick-start.mdx

The TanStack Start guide additionally had its query string after the fragment:

- /docs/local-development#inngest-dev-server?ref=tanstack-start-quick-start
+ /docs/local-development?ref=tanstack-start-quick-start#getting-started

As written, ?ref=… was part of the fragment, not a query parameter, so the ref attribution was silently lost. Reordered.

Happy to use a different target if you'd rather add an inngest-dev-server heading to local-development.mdx instead — 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 slugifyWithCounter the site uses, plus <Property name> ids and explicit id= attributes — then resolves every fragment link in pages/docs/**/*.mdx against 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.

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>
@vercel

vercel Bot commented Jul 26, 2026

Copy link
Copy Markdown

@dirnalafeinte is attempting to deploy a commit to the Inngest Team on Vercel.

A member of the Team first needs to authorize it.

@gester-bot gester-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified: local-development.mdx has a ## Getting started heading (anchor #getting-started) and no #inngest-dev-server anchor, so this fix is correct across all six files, including the query-param reordering in the tanstack-start file. No issues found.

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.

1 participant