Skip to content

docs: move quilt3.admin into the SDK API Reference nav - #5170

Open
sir-sigurd wants to merge 1 commit into
masterfrom
docs-admin-api-nav-fix
Open

docs: move quilt3.admin into the SDK API Reference nav#5170
sir-sigurd wants to merge 1 commit into
masterfrom
docs-admin-api-nav-fix

Conversation

@sir-sigurd

@sir-sigurd sir-sigurd commented Aug 5, 2026

Copy link
Copy Markdown
Member

Description

Follow-up to #5169, which did not have the intended effect.

GitBook renders one page per file. When SUMMARY.md references the same file from two places, only the first occurrence becomes a page and the second is dropped without warning. #5169 added api-reference/Admin.md to 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-server and 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.admin is listed once, in the API Reference group alongside the other pydocmd-generated module references (quilt3, quilt3.Package, quilt3.Bucket, quilt3.hooks), and Catalog/Admin.md ("Admin Settings UI") gains a prose link so administrators still have a path to it.

Two side effects worth noting:

  • The page moves off the /quilt-platform-administrator/admin-1 slug. It only had the deduplicating -1 suffix because Catalog/Admin.md already occupied .../admin in that same section; under the API Reference group the name is unclaimed. Anyone with the old URL bookmarked will need the new one.
  • Existing in-repo links (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-1 URLs in the tree.

TODO

  • Documentation
    • Markdown somewhere in docs/**/*.md that explains the feature to end users (said .md files should be linked from SUMMARY.md so they appear on https://docs.quilt.bio)

🤖 Generated with Claude Code

Greptile Summary

Moves the quilt3.admin page from the administrator navigation into the Python SDK API Reference, ensuring it appears only once in SUMMARY.md.

  • Adds a link from the Admin Settings UI guide to the Python API reference.
  • Groups quilt3.admin with 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

Filename Overview
docs/Catalog/Admin.md Adds a valid relative link from the administrator UI guide to the existing quilt3.admin API reference.
docs/SUMMARY.md Relocates the single quilt3.admin navigation 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

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

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.22%. Comparing base (9934506) to head (443c20d).

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           
Flag Coverage Δ
api-python 93.25% <ø> (ø)
catalog 25.18% <ø> (ø)
lambda 85.38% <ø> (ø)
py-shared 98.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant