Skip to content

Sweep v1.0.0 user docs readiness#28

Merged
gparadis merged 1 commit into
mainfrom
issue-27-docs-readiness
Jun 15, 2026
Merged

Sweep v1.0.0 user docs readiness#28
gparadis merged 1 commit into
mainfrom
issue-27-docs-readiness

Conversation

@gparadis

Copy link
Copy Markdown
Contributor

Summary

  • Sweep user-facing v1.0.0 docs for copy/paste failures and stale release language.
  • Fix README rendering, source-checkout vs PyPI wording, and outdated fhops evaluate / fhops eval-playback examples.
  • Move dashboards out of the first Getting Started slot, update v1.0.0 release-note status, and mark old alpha release notes as historical.
  • Record findings and deferred follow-ups in notes/docs_readiness_sweep.md.

Testing

  • .venv/bin/fhops validate examples/tiny7/scenario.yaml
  • .venv/bin/fhops solve-heur examples/tiny7/scenario.yaml --out tmp/docs-readiness/tiny7_sa.csv --iters 25 --seed 7
  • .venv/bin/fhops evaluate examples/tiny7/scenario.yaml --assignments tmp/docs-readiness/tiny7_sa.csv
  • .venv/bin/ruff format src tests
  • .venv/bin/ruff check src tests
  • .venv/bin/mypy src
  • .venv/bin/pytest (301 passed, 210 skipped, 61 warnings)
  • .venv/bin/pre-commit run --all-files
  • PANDOC_DIR=... PATH="$PANDOC_DIR:$PATH" .venv/bin/sphinx-build -b html docs _build/html -W

Addresses #27.

@gparadis gparadis merged commit d98fd10 into main Jun 15, 2026
2 checks passed
@gparadis gparadis deleted the issue-27-docs-readiness branch June 15, 2026 00:05
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.

1 participant