docs: question headings, job-page cross-links, last-modified stamps - #96
Merged
Merged
Conversation
Three measured gaps, from a pass over all 34 pages.
Headings: 0 of 236 H2s were question-shaped, though apps/web/CLAUDE.md asks
for questions where possible. 86 now are. Three headings carry an explicit
{#anchor} so existing deep links keep resolving, including the
/concepts/job-output redirect destination.
Internal links: the job pages were the least-linked pages in the docs.
image-upscale had zero in-body inbound links, compose, compress and
captions/burn had one each, while storage/index had 39. compose,
captions/animate and captions/burn had no closing links section at all.
In-body links go 213 to 269.
image-upscale 0 -> 4 compress 1 -> 8
compose 1 -> 7 captions/burn 1 -> 4
captions/animate 2 -> 5 ffprobe 3 -> 5
Freshness: metadata.timestamp was off, so no page showed when it last
changed. Mintlify reads the git commit date once it is enabled.
Also fixes two dead links found on the way: compose pointed at
/api-reference/assets, which 404s and has never existed, and the apex
support page links /docs/quickstart#authentication, an anchor that was
never emitted. The quickstart API-key step now carries that id.
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
1 participant
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.
Three measured gaps from a pass over all 34 pages.
1. Question-shaped headings: 0 of 236
apps/web/CLAUDE.mdasks docs to "use H2 headings as questions where possible". Compliance was zero. 86 headings now are questions. Question headings match how people and LLMs phrase queries and make each section independently extractable.Three headings carry an explicit
{#anchor}so existing deep links keep resolving:concepts/job#the-output(also adocs.jsonredirect destination),image-generate#watch-it-render,image-generate#discover-models.2. The job pages were the least-linked pages in the docs
jobs/image-upscalejobs/composejobs/compressjobs/captions/burnjobs/captions/animatejobs/ffprobeFor contrast,
storage/indexhad 39 andconcepts/job37.compose,captions/animateandcaptions/burnhad no closing links section at all, which is why they neither received nor passed authority. In-body links across the docs go 213 → 269.3. No freshness signal
metadata.timestampwas unset, so no page showed when it last changed. Enabled globally; Mintlify derives the date from the git commit.boost: 2added to the two pages people search for first.Two dead links fixed on the way
jobs/compose.mdxlinked/api-reference/assets→ 404, no such section exists. Now/sdk#uploads./docs/quickstart#authentication, an anchor Mintlify never emitted. The quickstart API-key step now carries that id, so the existing apex link resolves without an apex change.Test plan
After merge, verify the pinned anchors resolve and the timestamp renders.