Repository navigation
docs: improve README onboarding and clarify project scope - #21
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.
The README omitted steps needed to run the complete demo from source and overstated several unfinished features. This update makes onboarding reproducible and describes the behavior currently merged into
main.Validation: local links and anchors resolve; all 14 shell examples pass Bash syntax checks; example JSON parses;
docker compose config --quiet,git diff --check, and GitHub Markdown rendering pass. The conflict with the latestmainis resolved, and the resulting PR changes only README.md. Application tests were not rerun for this documentation-only update.