docs: restructure into per-interface guides, refresh branding, fix stale content [PYSDK-144]#664
Open
omid-aignostics wants to merge 6 commits into
Open
docs: restructure into per-interface guides, refresh branding, fix stale content [PYSDK-144]#664omid-aignostics wants to merge 6 commits into
omid-aignostics wants to merge 6 commits into
Conversation
…ale content Restructure - Add a pathologist-focused "Get started with Launchpad" guide plus dedicated CLI, Python Library, and MCP guides; all four share a single account-signup partial via a MyST include (one source of truth). - Thin and reorder the Home/README to orient -> decide -> act; make "Next Steps" action-first (run your first analysis, starting with Launchpad). Move the Platform Workflow overview + sequence diagram into the Platform Overview page. - Lead the opening paragraph with the Platform while naming the Python SDK, so it serves both the PyPI/GitHub README and the readthedocs "Platform Documentation". Branding - Aignostics brand colors (light/dark), favicon, theme-adaptive wordmark logo (white on dark, aubergine on light), left-aligned brand, subordinate subtitle, and a small footer version stamp. Remove the announcement link bar. Stale-content fixes - Drop the no-op aignostics[qupath,marimo] command (qupath extra is empty). - Fix dead client/utils.py reference (now platform/_utils.py). - Replace outdated run-state vocabulary with pending/processing/terminated + termination reasons; correct button/menu labels; reference -> external_id. - Bump documented SDK metadata schema version to v0.0.6. Tailor install depth per audience and regenerate README.md from partials. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
omid-aignostics
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR restructures the SDK documentation into interface-specific getting-started guides, updates branding/theming for the Read the Docs site, and refreshes stale platform terminology and metadata references.
Changes:
- Splits Launchpad, CLI, Python Library, and MCP onboarding into dedicated Sphinx pages backed by shared partials.
- Simplifies the README/home page and moves the platform workflow overview into the platform section.
- Updates documentation branding, footer version display, glossary terminology, and SDK metadata schema references.
Reviewed changes
Copilot reviewed 19 out of 27 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Regenerated top-level README with streamlined interface selection and updated platform/glossary content. |
| docs/source/main.rst | Removes the old home include wrapper. |
| docs/source/index.rst | Includes the home partial directly and adds Get started/Reference toctrees. |
| docs/source/get_started_launchpad.rst | Adds Sphinx wrapper for Launchpad guide. |
| docs/source/get_started_cli.rst | Adds Sphinx wrapper for CLI guide. |
| docs/source/get_started_library.rst | Adds Sphinx wrapper for Python Library guide. |
| docs/source/get_started_mcp.rst | Adds Sphinx wrapper for MCP guide. |
| docs/source/conf.py | Updates Furo branding options, favicon, and title. |
| docs/source/_templates/page.html | Adds a custom footer template with version stamp. |
| docs/source/_static/custom.css | Adds sidebar brand and footer version styling. |
| docs/source/_static/aignostics-wordmark-light.svg | Adds light-theme wordmark asset. |
| docs/source/_static/aignostics-wordmark-dark.svg | Adds dark-theme wordmark asset. |
| docs/partials/README_main.md | Reworks home/README content and next-step links. |
| docs/partials/README_platform.md | Updates run state terminology and moves platform workflow content here. |
| docs/partials/README_glossary.md | Updates Application Run and Reference glossary entries. |
| docs/partials/_get_started_signup.md | Adds shared account signup instructions. |
| docs/partials/get_started_launchpad.md | Adds Launchpad onboarding walkthrough. |
| docs/partials/get_started_cli.md | Adds CLI onboarding workflow. |
| docs/partials/get_started_library.md | Adds Python Library onboarding and examples. |
| docs/partials/get_started_mcp.md | Adds MCP server onboarding and configuration. |
| CLAUDE.md | Updates SDK metadata run schema version references. |
Codecov Report✅ All modified and coverable lines are covered by tests. |
omid-aignostics
added
skip:test:all
…n README [PYSDK-144] The README is generated from this partial and is also the PyPI long description, where a relative platform_overview.md link 404s. Use the absolute Read the Docs URL, matching the other links in the section. Addresses Copilot review feedback on PR #664. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Standardize on US spelling (canceled), align outputs-deletion wording with the terminated state, and fix the 'provide enable' grammar. Addresses Copilot review feedback on PR #664. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Switch the five screenshot references from /_static/... to _static/... (both build identically to _images/..., verified); the relative form is the conventional Sphinx style. Addresses Copilot review feedback. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…144] Update the workflow overview to 'multiple interfaces' enumerating all four (Launchpad, CLI, Python Library, MCP server), and use US 'canceled' in the cost paragraph for consistency with the API enum names. Addresses Copilot review feedback on PR #664. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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
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.
🛡️ Implements PYSDK-144 following CC-SOP-01 Change Control, part of our ISO 13485-certified QMS | Ketryx Project
Summary
aignostics[qupath,marimo]command (thequpathextra is empty); fix deadclient/utils.pyreference (nowplatform/_utils.py); replace outdated run-state vocabulary with pending/processing/terminated + termination reasons; correct GUI button/menu labels;reference→external_id; document SDK metadata schema version v0.0.6.Test plan
sphinx-build -W) passes with zero warnings; all four new pages and internal links/anchors render.make docsreproduces the change with all committed files byte-identical.auditjob fails on a pre-existing, unrelateduvadvisory (GHSA-4gg8-gxpx-9rph, fix 0.11.15), tracked separately.Scope
Documentation only — no
src/, dependency, API, or behavioural changes. Generated reference artifacts (API_REFERENCE_v1.md,CLI_REFERENCE.md,openapi_v1.*,ATTRIBUTIONS.md) are excluded; they aremake docs-driven and addressed separately.Posted by Claude claude-opus-4-8 via Claude Code, applying skills cc-sop-01 on behalf of Omid Kokabi