Restructure docs around a runnable local dev environment#1
Open
dnk8n wants to merge 1 commit into
Open
Conversation
dnk8n
commented
Jul 14, 2026
dnk8n
commented
Owner
- Rewrite README: what DTrack is, verified local quickstart (debug mode, no Azure), doc index, repo layout, project status (mvp-baseline)
- Add docs/architecture.md: schemas, api view pattern, role/RLS model, request lifecycle, onboarding, cyanaudit, initdb conventions, infra, version pins cross-referenced against July 2026 releases
- Add docs/development.md: prerequisites (incl. colima), one-time setup, dev vs debug modes, bootstrap order and its container-recreate quirk, everyday commands, direct API access with debug JWTs, troubleshooting
- Add docs/deployment.md: provisioning/deploy content moved out of README
- Move dtrack/dev/deploy.md to docs/runbooks/backup-restore.md; fold dtrack/dev/debug.md into docs/development.md
- Add make dev/debug/initdb/down/clean convenience targets
- Rewrite README: what DTrack is, verified local quickstart (debug mode, no Azure), doc index, repo layout, project status (mvp-baseline) - Add docs/architecture.md: schemas, api view pattern, role/RLS model, request lifecycle, onboarding, cyanaudit, initdb conventions, infra, version pins cross-referenced against July 2026 releases - Add docs/development.md: prerequisites (incl. colima), one-time setup, dev vs debug modes, bootstrap order and its container-recreate quirk, everyday commands, direct API access with debug JWTs, troubleshooting - Add docs/deployment.md: provisioning/deploy content moved out of README - Move dtrack/dev/deploy.md to docs/runbooks/backup-restore.md; fold dtrack/dev/debug.md into docs/development.md - Add make dev/debug/initdb/down/clean convenience targets Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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.