Uh oh!
There was an error while loading. Please reload this page.
docs: add "Invite your team" guidance to user guides [PYSDK-144] - #693
Merged
Conversation
The guides stated administrators can invite users but never explained how. Add a shared "Invite your team" partial (Console → Admin → Members) included at the end of all four getting-started guides (before the Launchpad troubleshooting section), and expand the Console section of the Platform Overview with the same steps as the canonical reference. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. |
Mirror the Ketryx report workflow change from #694 onto this branch so the non-required ketryx_report_and_check step no longer marks PR CI red while the Ketryx-side CCR/PAT 500 is being resolved. Build still lands in Ketryx. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
…144] Address review feedback: include the shared invite-your-team snippet on README_platform.md instead of a bespoke variant. Genericize the snippet's closing step so it no longer references a guide-specific signup section, so it reads correctly on all five pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
olivermeyer
approved these changes
Jul 21, 2026
olivermeyer
left a comment
Collaborator
There was a problem hiding this comment.
Please make sure you squash merge :-)
Uh oh!
There was an error while loading. Please reload this page.
omid-aignostics added a commit
that referenced
this pull request
Aug 14, 2026
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>
omid-aignostics added a commit
that referenced
this pull request
Aug 14, 2026
* docs: add "Get started with Console" user guide 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> * docs: hide the MCP server guide from the published documentation 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> * docs: address review feedback on the Console guide - 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> * docs: keep the invite guidance in the README partial 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> --------- Co-authored-by: Claude Opus 5 (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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The guides stated administrators can invite users but never explained how. Add a shared "Invite your team" partial (Console → Admin → Members) included at the end of all four getting-started guides (before the Launchpad troubleshooting section), and expand the Console section of the Platform Overview with the same steps as the canonical reference.