docs: add verified getting-started workflow - #13
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.
Summary
Why
CorpusKit had all required Dockerfiles and locked dependency manifests, but startup guidance was scattered and the native-development sequence was not runnable as written. A fresh empty-volume smoke also exposed a transient MinIO DNS race, and the root environment example contained blank typed settings that could not be loaded directly.
User impact
A new user now needs only Git and a running Docker Engine with Compose v2 for the local demo. Host Python, Node.js, npm, and eSpeak are not required. The guide clearly labels the demo identity as local-only and documents persistence, safe shutdown, destructive reset, port overrides, and the separate production path.
No
requirements.txtwas added:pyproject.toml+uv.lockremain the authoritative Python requirements, andpackage.json+package-lock.jsonremain authoritative for the web app.Validation
--profile web up --build --detach --waitdocker compose --profile web config --quietdocker compose --profile '*' config --quietuv lock --check, andgit diff --checkpassed