Docs + README: v0.3 surfaces + status badges#77
Merged
Conversation
Document the v0.3 surfaces — the VS Code extension and the per-model leaderboard — across the README and the MkDocs site, and add the standard status-badge row. - README: add the CI/Docs/PyPI/Python-versions/License badge row; add an "In your editor" section for the VS Code extension; extend "what gmat-copilot is not" with no-auto-apply and the board being the only hosted artifact; note the leaderboard submission path. - New docs/vscode.md: commands, settings, the apply-to-current-file flow, and the gmat-script division of labour. - New examples: an editor walkthrough and a reproduce-a-leaderboard-entry submission walkthrough; wired into the nav. - Refresh the public decisions snapshot with the VS Code surface and the leaderboard + anti-overfitting decisions. - getting-started: editor + leaderboard pointers; api: the leaderboard module; index: align "what it's not". Closes #68. Closes #51.
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
1 participant
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.
Documents the v0.3 surfaces — the VS Code extension and the per-model leaderboard — across the README and the MkDocs site, and adds the standard astro-tools status-badge row. Docs-only; no package changes.
README
Docs site
docs/vscode.md— commands, settings, the apply-to-current-file UX, and the gmat-script division of labour.getting-startedgains editor + leaderboard pointers;apidocuments the leaderboard module;indexaligns "what it's not".The existing
docs/leaderboard.mdalready covers the board, the public/held-out anti-overfitting design, the firewall, the schema, and the submit/verify flow, so it is unchanged.Verification
uv run mkdocs build --strictpasses with no warnings; the three new pages render.Closes #68.
Closes #51.