[codex] v2.6.0 DX and docs consolidation#27
Conversation
|
@codex review |
|
Follow-up pushed in 9249136 to make docs-consistency lint portable when ripgrep is unavailable and to add a no-rg regression test. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5afe4ec9f8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Follow-up pushed in 87de90c. The docs-consistency gate now requires full command-token matches, and there is a regression test proving longer commands like make demo-up and make build-desktop-web no longer satisfy shorter canonical commands. |
Summary
This release cuts SentinelID v2.6.0 and focuses on developer experience and documentation consolidation. The repository had drift between the docs, helper scripts, and the actual command path we validate in CI. That showed up most clearly in the beginner flow: copying
.env.exampleinto.envand following the runbook was not fully deterministic, and several docs still pointed people at raw scripts or outdated variable names instead of the canonical Make targets.The effect on users was avoidable setup churn. New contributors could land on contradictory guidance, helper scripts could silently depend on local state that the docs never asked them to create, and release-check did not guard against those documentation regressions. In practice, the path a maintainer used in CI and the path a beginner used locally were close, but not actually the same.
This change makes the command surface explicit and enforceable. The runbook now centers on
make install-dev,make demo-up,make demo-verify,make demo,make demo-down, andmake release-check. The release checklist now fails if the key docs drift back to deprecated script invocations or ambiguous env names. The fresh-clone bootstrap check now validates the runbook path from a clean snapshot of the current branch instead of assuming hidden local state.Root Cause
The repository had three underlying sources of drift:
cp .env.example .envplus the documented install steps.What Changed
v2.6.0across release-critical docs, Make help text, desktop config/package metadata, pilot evidence text, and cloud API metadata.make install-devmake check-version-consistencymake check-docs-consistencymake check-fresh-clonescripts/release/check_docs_consistency.shand integrated it intomake release-check.scripts/check_fresh_clone_bootstrap.shto validate the documented beginner path from a clean temp snapshot.docs/archive/README.mdand enforced thatdocs/root stays free ofphase*.mdfiles..env.exampleso the default local admin auth values are runnable for the documented demo path.make install-devnow creates the edge virtualenv in-project.scripts/smoke_test_cloud.shnow resolves the Poetry-managed edge interpreter correctly.scripts/smoke_test_cloud_recovery.shand release edge startup paths now prefer.venv/bin/python -m uvicorn.cryptographyinapps/edge/pyproject.toml.phase*.mdrule.Validation
Local validation completed on this branch:
make check-version-consistencymake check-docs-consistencysource apps/cloud/.venv/bin/activate && python -m pytest apps/cloud/tests/test_release_docs_consistency.py apps/cloud/tests/test_release_observability_scripts.pymake check-fresh-clonemake demo-upDEMO_AUTO_CLOSE_SECONDS=20 make demomake demo-downmake release-checkNotes