Add API resources reference tab (demo)#42
Open
scotwells wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
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.
Draft — for demo/preview only, not to merge yet.
Adds an API resources tab to the docs: a resource-and-field reference for the Datum Cloud API, generated from the ground-truth captures. This is the work that was pulled out of the CLI-docs PR (#40) and parked on
docs/api-reference-wipso it could land on its own.What's in it
api/— Concepts, Resource Manager, IAM, Compute, Networking (Gateway API / Envoy Gateway), DNS, IPAM, Quota, Billing, Telemetry, Notification, and Platform resources.docs.jsonnav entry adding the API resources tab alongside Docs and datumctl (CLI).Scope
Built fresh off current
main, so the diff is only the API tab — it does not touch the already-merged datumctl CLI section, does not re-introduce the retiredcli/*auto-generated pages, and carries the custom/self-hosted environment wording. The API overview's cross-link to the old CLI Commands tab was repointed atdatumctl --help.Status
The API reference is still a work in progress. This PR exists to get a Mintlify preview up for a demo — review the tab in the preview link before we decide on polish and merge timing.
🤖 Generated with Claude Code