docs: content audit sweep (grammar, links, structure)#306
Merged
Conversation
Top-level advanced/api/nitro-api dirs all shared prefix 3.; guides had five files at 1. and a duplicate 2.; advanced/api/nitro-api each had an internal duplicate too. Renumbered every directory so file order is intentional: getting-started -> guides -> advanced -> api -> nitro-api -> releases, and guides now reads how-it-works -> config methods -> indexing guides -> recipes -> bot detection -> AI directives. Numeric prefixes are stripped from URLs so no links change.
…nt passes
Nuxt Robots module docs, all six audit passes:
- Mechanical: comma splices, subject-verb agreement, US English
(behaviour/localise/favour -> behavior/localize/favor), missing
articles before X-Robots-Tag, stray characters, StackBlitz/DevTools
casing.
- Factual: Yandex advanced guide claimed "all search engines" ignore
Host/Crawl-delay; only Yandex deprecated them (Bing/Yahoo still
honor Crawl-delay). Scoped the claim to Yandex.
- Links: legacy /learn/ paths -> /learn-seo/nuxt/..., LearnLabel text
now matches the target page title ("Controlling Web Crawlers", not
"Conquering"), a genuinely dead /learn-seo/nuxt/mastering-meta/
social-sharing link repointed to the real open-graph page, and a
route-rules.md anchor that pointed at the wrong config option fixed.
- Frontmatter: titles/descriptions unquoted except where YAML needs
it (Yandex's colon), relatedPages added to every guide/api/advanced
page (2-4 entries: next logical page + closest cross-module page,
shape copied from the sitemap module), two nitro-api pages that
shared a copy-pasted "Site" description corrected to describe what
they actually return.
- Templates: installation.md's Next Steps converted from an ad-hoc
bullet list to the numbered reading-path shape used by sitemap;
config.md's own two "Should X be Y" option descriptions fixed to
match the "Whether to..." voice the page's docstring rule demands.
- Components: ::alert{type=} (not a real component) converted to
::note/::warning; a light-bulb ::callout summary with no `to=`
converted to ::tip; missing [nuxt.config.ts] fence labels added
across guides and release notes.
Not touched: troubleshooting.md's Debugging section has no
platform-specific issues to split out (robots has no per-host
quirks), so it stays as a single section rather than forcing the
og-image troubleshooting shape.
- Fix relatedPages title casing mismatch (Config Using Nuxt Config -> Config using Nuxt Config) to match the target page's actual title - Fix missed a/an article error on an already-touched line in advanced/i18n.md (a `allow` -> an `allow`)
commit: |
Structural pass over the thin-section detector's flags (42 -> 12, remaining 12 all THIN in releases/ which stays terse by design): - LONELY_CHILD: flattened single-child subheadings into their parent (bold lead-in replaces the removed heading) across robots-txt guide, yandex/content advanced pages, config/use-bot-detection/nitro-hooks API refs, and v5/v4/v3 release notes. - TOO_DEEP: demoted the six h4 code-example labels in ai-directives.md to bold lead-ins above their fences. - THIN in getting-started/advanced pages: folded troubleshooting.md's two short debugging subsections into their parent, and robots-txt.md's "Conflicting public/robots.txt" section into the file-placement section it belongs with. No prose added or reworded; every fix is a heading-level or placement change only.
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.
❓ Type of change
📚 Description
Docs-only sweep, part of a content audit across all Nuxt SEO module docs. Everything is under
docs/content/**.disallowNonIndexableRouteslinked to#robotsdisabledvalue) and a dead learn link (mastering-meta/social-sharingonly exists on the /vue/ tree; repointed to the nuxt equivalent)./learn/LearnLabel links repointed to/learn-seo/..., and the "Conquering Web Crawlers" label now matches the actual page title.::alert{type=}isn't a real prose component in this setup; converted to::note/::warning.1.and advanced/api/nitro-api all sat at3., so sidebar order was accidental. URLs unchanged.