docs: align README and docs with runtime contracts (live payload, API, diagrams, config) - #157
Merged
Merged
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
/liveresponse shape,max_dimdefaults/validation, architecture diagrams, and configuration environment variables) so user-facing docs are accurate and verifiable.Description
README.mdto document the actual/livepayload (adds runtime-dependentpid,timestamp, anduptime_seconds) and to replace the lightweight testing snippet with the current docs/validation commands such aspython scripts/validate_docs.pyandscripts/ci.sh docs-contract.docs/api-reference.mdto clarify thatmax_dimis optional at the route level (route defaultNone) and that validation enforces64 <= max_dim <= DEPTHLENS_MAX_DIM(configured default 1536).docs/system-architecture.mdand the static SVGdocs/architecture/depthlens-system-architecture.svgto include/live,/ready,/health,/comparealiases,/api/*aliases, detection endpoints, observability/metrics/cache routes, and the COCO detector node.docs/configuration.mdto surface route timeout/CORS variables, benchmark/ONNX diagnostic env vars, and clarified thatDEPTHLENS_CACHE_BACKEND=memoryis a CI/setup hint while the runtime attempts Redis then falls back to in-memory.docs/project-structure.mdand added theresource-path-contract.mdentry to the documented docs tree.Testing
python scripts/validate_docs.pywhich passed (documentation contract check succeeded).scripts/ci.sh docs-contractwhich executed the docs contract job and returned success in this environment.python -m py_compile backend/api/live.py backend/api/routes.py backend/main.py backend/app.py scripts/validate_docs.pywhich completed without syntax errors.npm --prefix electron-app testwhich executed the Electron frontend contract tests and the included resource/security checks and they passed in this environment.python -m pytest -q backend/tests/test_lightweight_live.py backend/tests/test_routes.py backend/tests/test_refactor_contract.py, but collection failed withModuleNotFoundError: No module named 'fastapi'because backend test dependencies are not installed; per constraints no dependency installation was performed, so pytest was not executed to completion.Codex Task