Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add markdown_url front matter so the About page links to /docs.md - #28281

Merged
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-678-add-markdown_url-front-matter-to-docsreadmemd-so-the-about
Aug 19, 2026
Merged

docs: add markdown_url front matter so the About page links to /docs.md#28281
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-678-add-markdown_url-front-matter-to-docsreadmemd-so-the-about

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

The docs About page renders at /docs/about, but its Markdown source is the docs root README.md, whose Markdown twin is /docs.md. The path-derived mapping (/docs/about -> /docs/about.md) points the "Copy page / view as Markdown" affordance and the sitewide rel="alternate" link at a URL that 404s for this page.

Add a markdown_url: /docs.md front-matter override to docs/README.md. It is inert for rendering and for /docs.md itself (the body still begins at # About); it only populates the front matter the docs site reads to advertise the correct Markdown alternate.

Reader side: coder/coder.com#1013 (DOCS-638). Neither change breaks without the other, so they can merge in either order.

Refs DOCS-678

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

The About page renders at /docs/about but its Markdown lives at /docs.md.
Add a markdown_url override so the docs site advertises the correct Markdown
alternate instead of the nonexistent /docs/about.md.

> This PR was created with AI assistance (Coder Agents).
@linear-code

linear-code Bot commented Aug 18, 2026

Copy link
Copy Markdown

DOCS-678

@github-actions

Copy link
Copy Markdown
Contributor

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 18, 2026 22:28

@Jesswinters Jesswinters left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🥳

@nickvigilante
nickvigilante merged commit fc6d6ba into main Aug 19, 2026
36 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-678-add-markdown_url-front-matter-to-docsreadmemd-so-the-about branch August 19, 2026 14:37
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants