docs(platform): add API Reference landing page (fix /api/ 404)#140
Merged
Conversation
Top-level sections on this site render their landing page from a README.md with an explicit url: (the section kind itself is not rendered), the same pattern used by guides/ and selfhost-setup/. The API Reference section only had _index.md, so /docs/platform/<ver>/api/ returned 404 and the section did not open from the nav. - Add docs/platform/api/README.md as the section landing page (url pinned to the section root, parent: api, weight: -1), linking to a leaf page per group since group roots are not rendered. - Reduce docs/platform/api/_index.md to a bare menu node, matching guides/_index.md and selfhost-setup/_index.md. Signed-off-by: Tamal Saha <tamal@appscode.com>
![kodiak-appscode[bot]](https://avatars.githubusercontent.com/in/92481?s=60&v=4){kind=small}
|
Visit the preview URL for this PR (updated for commit 0637799): https://kubedb-v2-hugo--pr140-docs-api-reference-l-tc97no2m.web.app (expires Tue, 21 Jul 2026 06:35:31 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
ArnobKumarSaha
approved these changes
Jul 14, 2026
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
2 participants
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.
Problem
On the live site, the API Reference top-level nav item links to
/docs/platform/<version>/api/, which returns 404 — the section does not open correctly (reported forv2026.7.10/welcome/).Cause
This site does not render the Hugo
sectionkind:_index.mdfiles only contribute menu nodes, and each top-level section's landing page is served by aREADME.mdwith an expliciturl:(the same pattern asguides/andselfhost-setup/, and the fix in #137). The API Reference section shipped with only_index.md, so nothing was generated at/api/.Fix
docs/platform/api/README.mdas the section landing page —url:pinned to the section root,parent: api,weight: -1,aliases— mirroringguides/README.mdandselfhost-setup/README.md. Its group table links to a leaf page per group (group roots aren't rendered either).docs/platform/api/_index.mdto a bare menu node, matching the other sections.Verification
lichefork (with-s) → local link check passes (README.md is excluded via-i '^README\.md$', and_index.mdno longer carries links).