docs: move quilt3.admin into the SDK API Reference nav - #5170
Open
sir-sigurd wants to merge 1 commit into
Open
Conversation
GitBook renders one page per file: when SUMMARY.md lists the same file twice, only the first occurrence appears and the second is dropped silently. Listing api-reference/Admin.md under both Quilt Platform Administrator and the SDK API Reference therefore left the API Reference entry invisible. Keep the single entry in the API Reference group, next to the other generated module references, and link to it from Admin Settings UI so administrators still have a path. As a side effect the page moves off the deduplicated /quilt-platform-administrator/admin-1 slug, which it was given because Catalog/Admin.md already occupied .../admin. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5170 +/- ##
=======================================
Coverage 48.22% 48.22%
=======================================
Files 827 827
Lines 34120 34120
Branches 5837 5837
=======================================
Hits 16455 16455
Misses 15781 15781
Partials 1884 1884
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Description
Follow-up to #5169, which did not have the intended effect.
GitBook renders one page per file. When
SUMMARY.mdreferences the same file from two places, only the first occurrence becomes a page and the second is dropped without warning. #5169 addedapi-reference/Admin.mdto the SDK's API Reference group while it was still listed under Quilt Platform Administrator, so the new entry never rendered.The same thing is already happening to
Catalog/MCP-Server.md, which is listed under both Quilt Platform (Catalog) User and Quilt Ecosystem Integrations: it renders at/quilt-platform-catalog-user/mcp-serverand is absent from the Ecosystem Integrations nav. That one is left alone here — where the MCP Server page belongs is a separate editorial call — but it is the same defect.This PR moves the entry rather than duplicating it:
quilt3.adminis listed once, in the API Reference group alongside the other pydocmd-generated module references (quilt3,quilt3.Package,quilt3.Bucket,quilt3.hooks), andCatalog/Admin.md("Admin Settings UI") gains a prose link so administrators still have a path to it.Two side effects worth noting:
/quilt-platform-administrator/admin-1slug. It only had the deduplicating-1suffix becauseCatalog/Admin.mdalready occupied.../adminin that same section; under the API Reference group the name is unclaimed. Anyone with the old URL bookmarked will need the new one.Quickstart.md,CrossAccount.md,advanced-features/tabulator.md) are relative links to the file, so GitBook rewrites them to the new location automatically. No repo link needs updating, and there are no hardcoded/admin-1URLs in the tree.TODO
🤖 Generated with Claude Code
Greptile Summary
Moves the
quilt3.adminpage from the administrator navigation into the Python SDK API Reference, ensuring it appears only once inSUMMARY.md.quilt3.adminwith the other generated SDK module references.Confidence Score: 5/5
The documentation-only change appears safe to merge.
The target API reference exists, the new relative link follows established documentation conventions, and the navigation entry matches its sibling API reference entries without leaving a duplicate.
Important Files Changed
quilt3.adminAPI reference.quilt3.adminnavigation entry into the SDK API Reference group without changing its target file.Reviews (1): Last reviewed commit: "docs: move quilt3.admin into the SDK API..." | Re-trigger Greptile