Skip to content

Commit 455ab85

Browse files
committed
docs: refresh index landing page for v0.1
Drop the unreleased Docker/GHCR reference (scoped for v0.3), drop the 'not yet usable' status, and align the version tag with v0.1. Add a brief subnav linking to the four doc pages.
1 parent 91069fc commit 455ab85

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

docs/index.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@
33
A GitHub Action that installs [NASA GMAT](https://gmat.gsfc.nasa.gov/) and bootstraps `gmatpy` for use in CI workflows.
44

55
```yaml
6-
- uses: astro-tools/setup-gmat@v1
6+
- uses: actions/setup-python@v5
7+
with:
8+
python-version: '3.12'
9+
- uses: astro-tools/setup-gmat@v0.1
710
with:
811
version: R2026a
9-
- run: python -c "import gmatpy"
1012
```
1113
12-
A canonical Docker image on GitHub Container Registry is published alongside the action for ad-hoc local use and for downstream container layering.
14+
## Status
1315
14-
```bash
15-
docker run --rm -it ghcr.io/astro-tools/gmat:R2026a python -c "import gmatpy"
16-
```
16+
v0.1 is the first usable release: GMAT R2026a on Linux runners (`ubuntu-latest`), caching across runs, and a built-in smoke check that loads and runs a stock GMAT sample. Windows and macOS support and the R2022a–R2026a version matrix are scoped for v0.2; see the [README roadmap](https://github.com/astro-tools/setup-gmat#roadmap) for the full plan.
1717

18-
## Status
18+
## Where to next
1919

20-
setup-gmat is under active development. The action is not yet usable.
20+
- [Getting started](getting-started.md) — minimum workflow, prerequisites, and how to call `gmatpy` from your own steps.
21+
- [Inputs and outputs](inputs-outputs.md) — full reference for `action.yml`, including cache key shape and install layout.
22+
- [FAQ](faq.md) — Python prerequisite, cache invalidation, supported versions.
23+
- [Troubleshooting](troubleshooting.md) — known failure modes mapped to the action's error messages.

0 commit comments

Comments
 (0)