Skip to content

docs: simplify Console guide and focus docs on Console, Library and API - #718

Merged
omid-aignostics merged 11 commits into
mainfrom
docs/get-started-console-guide
Sep 9, 2026
Merged

docs: simplify Console guide and focus docs on Console, Library and API#718
omid-aignostics merged 11 commits into
mainfrom
docs/get-started-console-guide

Conversation

@omid-aignostics

@omid-aignostics omid-aignostics commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Console guide rewritten as a minimal tutorial — plain markdown throughout (no cards, tabs, dropdowns or admonition boxes), one numbered action per line, eight steps from install to download, and one optional step for copying slides from an existing AWS S3 / Azure Blob / Google Cloud Storage bucket with rclone. 2,373 → 1,109 words.
  • Troubleshooting and Invite your team are their own pages, linked from "Where to go next", so the guide only contains the path from sign-up to downloaded results.
  • Shared sign-up and invite partials tightened — each numbered step is the instruction itself; fallbacks (spam folder etc.) moved to Troubleshooting.
  • Docs focused on Console, the Python Library and the REST API — the Launchpad and CLI guides, the CLI reference and the API v1 reference are hidden from the published docs (files kept, excluded from the build, same convention as the MCP guide). README and guide links repointed accordingly; README.md regenerated.

Verification

  • sphinx-build clean build: zero warnings; hidden pages absent from output; all internal links resolve.
  • ruff format --check passes.
  • rclone backend options verified against rclone docs; whoami field names and the S3-compatible GCS endpoint verified against platform/_service.py and bucket/_service.py.

Notes for reviewers

  • Docs-only change.
  • Two pre-existing local-hook issues surfaced while pushing, unrelated to this change and worth separate tickets: the uv-lock hook rewrites uv.lock cosmetically under uv 0.12.x (hook pins 0.11.6), and the regenerated API_REFERENCE_v1.md fails ruff format --check.

🤖 Generated with Claude Code

@omid-aignostics @claude
docs: simplify Console guide and focus docs on Console, Library and API
8489b23 
Rewrite the "Get started with Console" guide as a minimal tutorial: plain
markdown, numbered actions per step, one optional step for copying slides
from an existing cloud bucket with rclone. Move Troubleshooting and
"Invite your team" to their own pages, linked from "Where to go next".
Tighten the shared sign-up and invite partials.

Hide the Launchpad and CLI guides, the CLI reference and the API v1
reference from the published docs (files kept, excluded from the build),
and repoint README and guide links to Console, the Python Library, and the
API Explorer.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics
omid-aignostics requested a review from a team as a code owner September 8, 2026 11:09
@omid-aignostics omid-aignostics added the skip:test:long_running Skip long-running tests (≥5min) label Sep 8, 2026
omid-aignostics and others added 6 commits September 8, 2026 13:17
@omid-aignostics @claude
docs: link "Invite your team" from all guides instead of embedding it
370bac2 
Remove the inline invite section from the Library guide and the Platform
overview, and give the Library and API guides the same "Where to go next"
list as the Console guide, so the invite steps live on one page only.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: move "We take quality and security seriously" to Operational Ex…
eca66e3 
…cellence

The paragraph describes how the SDK is built, not how to use it, and
already pointed at the Operational Excellence page — make it that page's
introduction and take it off the README / docs home page.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: drop Troubleshooting bullet from Console guide's Where to go next
ff681cb 
The page stays in the Get started sidebar; no other guide links it inline.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: make Troubleshooting entries self-contained as a standalone page
a1ca305 
Name the command or Console screen each entry refers to instead of relying
on the surrounding guide, and state the page's scope up front.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: drop "System health checks" from the Python Library guide
d15e166 
A getting-started guide should not explain what the library does not do;
the system module remains documented in the Library reference.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: rewrite Python Library guide to mirror the Console workflow
1b540c0 
Restructure the guide as the same first analysis as the Console guide, one
snippet per step: install, log in (browser or refresh token), upload slides
with computed metadata, start Atlas H&E-TME, follow the run state and
per-slide outcomes, download results, list/cancel/clean up. Replace the
placeholder test-app snippet, and move notebooks to "Where to go next".

Also drop the "Step N:" prefixes from the API guide's login headings for
consistency with the Console guide.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics
omid-aignostics force-pushed the docs/get-started-console-guide branch from 3ce2b47 to 1b540c0 Compare September 8, 2026 11:41
omid-aignostics and others added 2 commits September 8, 2026 13:47
@omid-aignostics @claude
docs: move headless refresh-token setup out of the Library guide's Lo…
5784dce 
…g in step

A first analysis needs a browser login only; running without a browser is
an alternative path, so it becomes a Troubleshooting entry instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: describe the bucket as provided by Aignostics, not as "private"
8d55e4b 
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Sep 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

❗ There is a different number of reports uploaded between BASE (7c23819) and HEAD (e15082f). Click for more details.

HEAD has 41 uploads less than BASE
Flag BASE (7c23819) HEAD (e15082f)
42 1

see 24 files with indirect coverage changes

olivermeyer
olivermeyer reviewed Sep 8, 2026
View reviewed changes
Comment thread docs/partials/get_started_console.md
olivermeyer
olivermeyer reviewed Sep 8, 2026
View reviewed changes
Comment thread docs/partials/get_started_console.md
olivermeyer
olivermeyer reviewed Sep 8, 2026
View reviewed changes
Comment thread docs/partials/get_started_launchpad.md Outdated
omid-aignostics and others added 2 commits September 8, 2026 17:28
@omid-aignostics @claude
docs: number the steps in the Library and API guides like the Console…
e2ff249 
… guide

Same two parts (Upload your slides, Analyze your slides with Atlas H&E-TME)
and numbered steps in all three getting-started guides.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@omid-aignostics @claude
docs: drop duplicate FAQ entry from the hidden Launchpad guide
e15082f 
The entry now lives on the Troubleshooting page.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Sep 8, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@omid-aignostics
omid-aignostics merged commit e3633c7 into main Sep 9, 2026
50 of 53 checks passed
@omid-aignostics
omid-aignostics deleted the docs/get-started-console-guide branch September 9, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@olivermeyer olivermeyer olivermeyer approved these changes

Assignees

No one assigned

Labels

skip:test:long_running Skip long-running tests (≥5min)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@omid-aignostics @olivermeyer