docs(platform): high-level API design pages (overview + per-group)#141
Merged
Conversation
Add a top-level API Overview page (system architecture, auth model, request flows, deployment modes) and an Overview page for each of the 18 API groups. Mermaid diagrams are rendered to SVG under images/ since the site has no native mermaid support. Signed-off-by: Arnob Kumar Saha <arnob@appscode.com>
|
Visit the preview URL for this PR (updated for commit a68b2b6): https://kubedb-v2-hugo--pr141-arnob-hld-docs-ib95zbh0.web.app (expires Tue, 21 Jul 2026 06:50:46 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
Signed-off-by: Arnob Kumar Saha <arnob@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
Adds high-level design docs alongside the existing low-level
docs/platform/api/reference, sourced fromprompt-library/docs/hld.md.api/overview.md— cross-cutting design: system architecture, authentication/authorization model, API-group map, typical request flows, deployment modes. Linked fromapi/_index.md.<group>/overview.md— one per API group, carrying that group's full design + endpoint tables, ending with links to the group's reference pages. Each surfaces as an Overview entry in the left nav (weight 5, sorts first).api/images/— the 5 mermaid diagrams from the source rendered to SVG, since the site has no native mermaid support (they would otherwise render as raw code blocks).Notes
liche -p -h -l -s -i '^README\.md$') using theappscodelabs/liche@arnob-strip-prefixfork.../link convention and/#anchorform.