docs: add self-guided adventures to README#13
Merged
Conversation
Four hands-on walkthroughs for newcomers: running the pipeline and its verification gates, exploring typed dataclasses in the REPL, reverse- engineering models from the XSD via xsdata, and generating/viewing the XSD documentation. Each loop is run-verified and links to the relevant concept docs and source. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
|
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.
What
Adds a Self-guided adventures section to the README — four short, hands-on loops that take a newcomer from "the Codespace opened, now what?" to actually running, exploring, and understanding the pipeline.
Each adventure follows the same shape: run a command → look at what it produced → peek at the code that did it → read the concept doc that explains why.
make verify,acoustic pipeline,validate,compare.Platform, feel why a typo is aTypeErrorand not a silent dict key.@dataclass, see thexsdatainvocation ingenerate.py.acoustic gen-schema-docs(xs3p HTML reference) andmake docs-serve(MkDocs Material site).Verification
Every command in the new section was run end-to-end before documenting, so the shown output matches reality. The transient model regeneration produced during verification was reverted; the only file changed in this PR is
README.md.🤖 Generated with Claude Code
Generated by Claude Code