Skip to content

docs(style): formalize recommendation voice and page-level weights - #7654

Open
sanderson wants to merge 1 commit into
masterfrom
docs/style-conventions
Open

docs(style): formalize recommendation voice and page-level weights#7654
sanderson wants to merge 1 commit into
masterfrom
docs/style-conventions

Conversation

@sanderson

Copy link
Copy Markdown
Collaborator
  • Recommendations use first-person plural ("We recommend..."), not third-party attributions, matching existing practice across the docs (Google.We and Google.FirstPerson are already disabled in Vale)
  • Set weight at the page level rather than on the menu entry: menu items inherit it, and page-level weight keeps children-shortcode and other non-menu listings sorted (Hugo sorts unweighted pages after weighted ones, so mixed placement within a section breaks ordering)

Documented in the canonical agent instructions (adapters regenerated) and DOCS-FRONTMATTER.md.

Checklist

  • Rebased/mergeable
  • Local build passes (npx hugo --quiet)

- Recommendations use first-person plural ("We recommend..."), not
  third-party attributions, matching existing practice across the docs
  (Google.We and Google.FirstPerson are already disabled in Vale)
- Set weight at the page level rather than on the menu entry: menu items
  inherit it, and page-level weight keeps children-shortcode and other
  non-menu listings sorted (Hugo sorts unweighted pages after weighted
  ones, so mixed placement within a section breaks ordering)

Documented in the canonical agent instructions (adapters regenerated)
and DOCS-FRONTMATTER.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sanderson
sanderson requested a review from a team as a code owner August 14, 2026 19:05
@sanderson
sanderson requested review from jstirnaman and removed request for a team August 14, 2026 19:05
@github-actions

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 2
Warnings (2)
File Line Rule Message
content/AGENTS.md 12 InfluxDataDocs.Spelling Did you really mean 'Shortcodes'?
content/AGENTS.md 281 Google.Colons ': S' should be in lowercase.

Check passed

@github-actions

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED (full site)
Preview View preview
Build time 81s
Last updated 2026-08-14 19:09:51 UTC
Changed pages (1)

Preview auto-deploys on push. Will be cleaned up when PR closes.

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