docs: add "Get started with Console" user guide - #712
Conversation
9b65d09 to
f16146a
Compare
omid-aignostics
changed the title
f16146a to
c5719f7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. |
| uvx aignostics bucket upload ./my-slides | ||
| ``` | ||
|
|
||
| A progress bar appears, and the message `All files uploaded successfully!` tells you the upload is done. |
There was a problem hiding this comment.
No progress bar for me. Only messages
There was a problem hiding this comment.
Good catch — this is a real rendering problem, not just a wrong sentence in the guide. The bar does exist (bucket/_cli.py:85-98) but it shares one line with a long TextColumn (Uploading from <source> to gs:/<bucket>/<prefix>) plus six more columns — progress, time remaining, file size, total size, transfer speed, and the per-file description. BarColumn is the flexible one, so it is what gets squeezed.
I reproduced it by rendering those exact columns at different widths:
| Terminal width | Bar glyphs |
|---|---|
| 80 | 0 |
| 100 | 2 |
| 120 | 10 |
| 160+ | 39 (full) |
At 80 columns — the default on a fresh terminal — there is nothing left for the bar, and even the percentage truncates to 3…. That matches what you saw exactly.
Fixed the guide in 9b4e861 to describe what actually shows up:
The command first reports how many files it found and their total size, then names each slide as it goes up. When it is finished it lists what it uploaded and prints
All files uploaded successfully!. A progress bar is part of that output, but it only shows up if your terminal window is wide enough — in a standard-width window there is no room for it, so you see the messages alone.
The underlying CLI issue is worth fixing separately, since a squeezed-to-nothing progress bar during a multi-GB upload is exactly when a user wants feedback. Shortening the description column (or moving the destination to a line printed once, before the bar) would buy back the width. Happy to file that as an anomaly if you agree — it is out of scope for a docs PR.
Posted by Claude claude-opus-5 via Claude Code on behalf of Omid Kokabi
Adds a guide for the flow where slides are uploaded to the organization's bucket with the Python SDK and analyzed in Console at platform.aignostics.com, which is easier for non-technical users than the Launchpad GUI. Structure follows sign up -> upload your slides -> analyze your slides with Atlas H&E-TME, with five screenshots of Console (create run form, slide selection from the bucket, run parameters, viewer overlays, result download), the 30-day result retention window, and a troubleshooting section. Links the guide from the docs index and the interface table in README. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The MCP server is not yet usable for customers, so advertising it in the documentation sends readers to instructions they cannot act on. Excludes get_started_mcp.rst from the Sphinx build, drops it from the "Get started" toctree, and comments out the MCP row in the interface table. The guide and its partial stay in the repository; each change carries a note on how to restore it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- Create the download target folder before use: `dataset idc download` declares target with exists=True, so a missing directory aborts with "Invalid value for 'target'". Adds mkdir and names the error. - Use my-slides consistently: Step 4 now downloads the example slide into the same folder Step 5 uploads, instead of introducing data/. - Stop promising a progress bar unconditionally. The bar shares a line with a long description and 6 further columns, so rich squeezes it to zero glyphs at 80 columns and 2 at 100; it needs ~160 to render fully. The guide now describes the messages and when the bar appears. - Fix image paths for GitHub: _static/console/* resolved only relative to docs/source, so the images 404 when reading the partial on GitHub. ../source/_static/console/* resolves in both GitHub and the Sphinx build (verified: build succeeded, images copied to _images/). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
README.md is generated from docs/partials/README_*.md (noxfile.py _generate_readme), but #693 added the "Inviting and managing users" section to README.md only. Regenerating the README therefore dropped it, which is what this branch did. Moves the section into docs/partials/README_platform.md, next to the roles it belongs with, and regenerates README.md so the content survives the next regeneration. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
9b4e861 to
df75ca6
Compare
|
2 participants
…ong-running, skip:test:matrix-runner, skip:test:very-long-running]
Adds a guide for the flow where slides are uploaded to the organization's bucket with the Python SDK and analyzed in Console at platform.aignostics.com, which is easier for non-technical users than the Launchpad GUI.
Structure follows sign up -> upload your slides -> analyze your slides with Atlas H&E-TME, with five screenshots of Console (create run form, slide selection from the bucket, run parameters, viewer overlays, result download), the 30-day result retention window, and a troubleshooting section.
Links the guide from the docs index and the interface table in README.