Docs + README: v0.3#56
Merged
Merged
Conversation
Fill the v0.3 documentation gaps left after the linter, LSP, and VS Code extension landed: - New field-catalogue reference (docs/catalogue.md): the build-time vs. runtime split and GMAT-free guarantee, the FieldSpec/TypeSpec shape, the query API, versioning/target_version, and the regeneration/version-bump process. - New VS Code extension guide (docs/vscode.md): install (Marketplace / Open VSX), features, format-on-save, and settings; trim the LSP page's VS Code subsection to a pointer. - README: add an Editor tooling section with Marketplace + Open VSX badges and links, and a bundled-catalogue note in the GMAT-version section. - index/api: de-stale the "linting/editor tooling to follow" wording now that both have shipped, and add the new pages to the navigation and cross-links. - examples: a runnable lint walkthrough (lint_script.py) showing a flawed script's diagnostics and the same script clean. - Concrete demo.gif recording steps for the extension's marketplace listing. The site builds with mkdocs build --strict. Refs #25
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.
Summary
v0.3 documentation, filling the gaps left after the linter, language server, and VS Code extension landed (their own PRs already shipped
lint.md/lsp.md):docs/catalogue.md) — the build-time-vs-runtime split and the GMAT-free guarantee, theFieldSpec/TypeSpecshape, the query API,target_versionselection, and the regeneration / version-bump process.docs/vscode.md) — install (Marketplace / Open VSX), features, format-on-save, and settings; the LSP page's VS Code subsection is trimmed to a pointer.examples/lint_script.py): a flawed script's diagnostics, then the same script clean.The lint-rule catalogue in
lint.mdwas verified complete and matching the implemented rules (8 rules +syntax-error, severities confirmed againstrules.py).Test plan
mkdocs build --strict— clean (no broken links / nav warnings)python examples/lint_script.pyruns; output matches what the docs showruff check,ruff format --check,mypyon the new example — cleandemo.gifrecorded and the../README.mdreference uncommentedCloses #25