Skip to content

docs: fix broken .style/ link and lift details block out of list item [DOCS-661] - #28180

Open
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/docs-661-fix-broken-style-inter-doc-link-and-details-in-list
Open

docs: fix broken .style/ link and lift details block out of list item [DOCS-661]#28180
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/docs-661-fix-broken-style-inter-doc-link-and-details-in-list

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

What

Two small docs fixes, split out of the offlinedocs Fumadocs migration (#27390) so that PR stays a focused tooling change and these land on their own review track.

  • docs/about/contributing/documentation.md: the Vale style-guide link pointed at docs/.style/style-guide/, which is excluded from the published docs corpus, so the relative link 404s on the live site. Repointed to an absolute github.com URL.
  • docs/ai-coder/ai-gateway/monitoring.md: lifted the "Possible client values" <details> block out of the list item so it renders as a top-level accordion, and restored a dropped blockquote continuation marker (>).

Why

Both are genuine docs bugs on their own:

  • The .style/ link is broken on the live site today, because that directory is intentionally excluded from the published corpus.
  • The <details> nested inside a list item renders inconsistently; lifting it to a sibling block is portable across renderers.

They are also prerequisites for the offlinedocs Fumadocs migration, whose stricter build-time sync hard-fails on unmapped inter-doc links and only converts a <details> to an accordion when it is a list sibling. Landing them here first lets the migration PR drop these two files on its next rebase.

Validation

  • make fmt/markdown and make lint/markdown: clean (via pre-commit-light).
  • Docs-only change; no CI or build config touched.

This PR was created with AI assistance (Coder Agents).

- documentation.md: the Vale style-guide link pointed at docs/.style/style-guide/,
  which is excluded from the published docs corpus, so the relative link 404s on
  the live site. Repoint it to an absolute github.com URL.
- monitoring.md: lift the "Possible client values" <details> block out of the list
  item so it renders as a top-level accordion, and restore the dropped blockquote
  continuation marker.
@linear-code

linear-code Bot commented Aug 14, 2026

Copy link
Copy Markdown

DOCS-661

@github-actions

Copy link
Copy Markdown

Docs preview

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

@nickvigilante
nickvigilante marked this pull request as ready for review August 14, 2026 18:31
@nickvigilante
nickvigilante enabled auto-merge (squash) August 14, 2026 18:31
@nickvigilante
nickvigilante requested a review from bpmct August 14, 2026 18:31
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