Refresh documentation and developer commands#38
Open
MontrealAI wants to merge 1 commit into
Open
Conversation
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
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.
Motivation
proof_gradientpackage and local API surface.skillosreferences and scattered validation instructions with a single, discoverable developer quick start andmaketargets.Description
README.mdto add a Local developer quick start, point todocs/api_reference.md, and refresh the repository map to includeproof_gradient/andschemas/.Makefileto usepython -m proof_gradiententry points, addhelp/api/validatetargets, switch tests topytest, and improvecleanrules.docs/api_reference.mdto document the real FastAPI endpoints (/healthz,/readyz,/metrics,/tenants,/demo/run,/artifacts,/runs,/proofs) and themake apiflow.docs/GOALOS_DOCUMENTATION_INDEX.md,CONTRIBUTING.md, andQA_VERIFICATION.mdto reference the API docs, prefermake validate, and add guidance to keep docs, API reference, Makefile, and QA notes synchronized.Testing
python -m pip install -e ".[dev]", which completed successfully.pytest(andmake test), which passed: 85 tests passed with 2 FastAPI/Starlette deprecation warnings.make validate, which executedpython scripts/check_no_paid_artifacts.py,python scripts/validate_goalos_catalog.py,python scripts/validate_docs_tables_figures.py, andpython scripts/validate_goalos_public_site.py, and all validators passed.Codex Task