Skip to content

docs: refresh README + docs landing surface for v0.2 - #58

Merged
djankov merged 1 commit into
mainfrom
issue-43-readme-v02-surface
May 1, 2026
Merged

djankov merged 1 commit into
mainfrom
issue-43-readme-v02-surface

Conversation

@djankov

@djankov djankov commented May 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

No changes to docs/getting-started.md or docs/index.md — both already reflect the three-OS surface (verified during planning).

Test plan

  • mkdocs build --strict clean (cross-link to faq.md#what-about-r2023a-and-r2024a resolves)
  • npx prettier --check clean across all changed files
  • Docs workflow green on CI

Closes #43

- README quick start: matrix is now 3-OS (ubuntu/windows/macos) on a single GMAT version, replacing the single-OS single-version stub. Adds a pointer to the multi-version compatibility recipe for consumers who want to vary GMAT version too.
- README roadmap: drop the v0.2 row (its scope shipped in #48/#49/#50/#51/#52) and relabel the new top row as v0.2 (current).
- docs/inputs-outputs.md: version input description gains a one-line note that R2023a/R2024a were never released, linking to the canonical FAQ entry. gmat-root output description drops the now-stale "in v0.1" qualifier (the path is the same in v0.2).
- docs/faq.md: download-verification entry drops the "in v0.1" qualifier — the action still does not verify a checksum or signature in v0.2; supply-chain hardening remains on the v0.3 roadmap.

Closes #43
@djankov
djankov marked this pull request as ready for review May 1, 2026 18:33
@djankov
djankov merged commit 0492f7c into main May 1, 2026
11 checks passed
@djankov
djankov deleted the issue-43-readme-v02-surface branch May 1, 2026 18:34
@djankov djankov mentioned this pull request May 1, 2026
2 of 6 tasks
djankov added a commit that referenced this pull request May 1, 2026
- Populate CHANGELOG.md with the [0.2.0] - 2026-05-01 section, aggregated from the 11 merged v0.2 PRs (#47, #48, #49, #50, #51, #52, #53, #55, #56, #57, #58).
- Bump package.json version from 0.1.0 to 0.2.0.

The v0.2 row in the README roadmap was already trimmed-and-relabelled (`v0.2 _(current)_`) by #58 ahead of the cut, mirroring the v0.1 cut precedent (#35), so no README change is needed here.

Closes #46.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README + inputs/outputs docs: v0.2 surface

1 participant