docs(platform): consolidate API overview + section index into README#143
Merged
Conversation
Each API group directory carried two near-duplicate landing pages: an _index.md (section intro + page list) and an overview.md (endpoint tables). Merge them into a single README.md per group: - README.md now holds the merged content (intro, endpoint tables, page list); it renders at the section root via `url:` and aliases the old `.../overview/` URL so existing links keep working. - _index.md is reduced to frontmatter only (section/menu metadata). - overview.md is removed (superseded by README.md). At the top level, the High-Level Design overview is folded into the API Reference README, deduplicating the Authentication and API Groups sections into one, and the `.../api/overview/` URL is aliased. 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 714368f): https://kubedb-v2-hugo--pr143-docs-consolidate-api-fkxo5lpz.web.app (expires Tue, 21 Jul 2026 08:43:29 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
The sidebar partial (menu/group.html) skips a group's child menu entries whose weight is -1 (that value marks a section-landing headline). The consolidated per-group README.md pages were created with weight -1, so they disappeared from the left column instead of appearing as "Overview". Give the 18 per-group READMEs a positive weight (1) so they render as the first "Overview" link under each group, matching the old overview.md behavior. The top-level README stays weight -1 (it is a direct section child rendered by menu/leaf.html, which does show it, as the section headline). Signed-off-by: Tamal Saha <tamal@appscode.com>
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.
What
Consolidates the two near-duplicate landing pages that each API-group directory carried —
_index.md(section intro + page list) andoverview.md(endpoint tables) — into a singleREADME.mdper group.Changes
Per API group (18 subdirectories):
README.md(new) — holds the merged content: group intro, endpoint tables, and a## Pagesnav list. Renders at the section root viaurl:, and aliases the old.../overview/URL so existing links keep resolving._index.md— reduced to frontmatter only (section/menu metadata).overview.md— removed (superseded byREADME.md).Top-level
api/:overview.mdinto the existing API ReferenceREADME.md, deduplicating the Authentication and API Groups sections into one each, and fixing image/cross-link paths to the README's link base..../api/overview/URL.overview.md.Notes
overview.mdremoved, 19README.md(18 new + top-level updated), 19_index.mdretained (frontmatter-only for subdirs). No dangling references tooverview.md/_index.mdremain in the tree.docs/platform/api/) is touched; the generatedkubedb.dev/websitecopy is not part of this PR.