Skip to content

docs: list quilt3.admin under the Python SDK API Reference - #5169

Merged
sir-sigurd merged 1 commit into
masterfrom
docs-link-admin-api
Aug 5, 2026
Merged

docs: list quilt3.admin under the Python SDK API Reference#5169
sir-sigurd merged 1 commit into
masterfrom
docs-link-admin-api

Conversation

@sir-sigurd

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

Copy link
Copy Markdown
Member

Description

docs/api-reference/Admin.md (the generated quilt3.admin reference) is linked from SUMMARY.md only under Quilt Platform Administrator. The Quilt Python SDK → API Reference group lists quilt3, quilt3.Package, quilt3.Bucket and quilt3.hooks, but not quilt3.admin — so a reader browsing the SDK's API reference has no path to the admin API, and the site's own front page advertises API docs only under the SDK.

This adds the missing entry alongside the other generated module references. The page keeps its existing URL; listing a file in two places is already how Catalog/MCP-Server.md is handled in this table of contents.

Note that the page's published URL is /quilt-platform-administrator/admin-1 — GitBook derives the slug from the filename, and Catalog/Admin.md ("Admin Settings UI") already claims /quilt-platform-administrator/admin in the same section, so this one gets the de-duplicating -1 suffix. That slug isn't controllable from the repo (.gitbook.yaml supports only root, structure and redirects), so it's left alone here; navigation is the part that can be fixed in git.

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

Adds the existing quilt3.admin API reference to the Quilt Python SDK navigation.

  • Links api-reference/Admin.md alongside the other generated SDK module references.
  • Keeps the existing administrator-section entry and published page URL unchanged.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The added navigation target exists with matching path and case, and the repository evidence reveals no documentation contract or validation rule violated by listing it in both relevant sections.

Important Files Changed

Filename Overview
docs/SUMMARY.md Adds a valid navigation link to an existing API reference page; no actionable issue identified.

Reviews (1): Last reviewed commit: "docs: list quilt3.admin under the Python..." | Re-trigger Greptile

The generated quilt3.admin reference was reachable only from the Quilt
Platform Administrator section, so readers browsing the SDK's API
Reference group had no path to it.

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 (4cd755b) to head (c240256).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5169   +/-   ##
=======================================
  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.

@sir-sigurd
sir-sigurd merged commit 9934506 into master Aug 5, 2026
45 checks passed
@sir-sigurd
sir-sigurd deleted the docs-link-admin-api branch August 5, 2026 14:42
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