Skip to content

docs: add PLAYGROUND.md hands-on guide#12

Open
IanMayo wants to merge 1 commit into
mainfrom
docs/playground-guide
Open

docs: add PLAYGROUND.md hands-on guide#12
IanMayo wants to merge 1 commit into
mainfrom
docs/playground-guide

Conversation

@IanMayo

@IanMayo IanMayo commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds PLAYGROUND.md — a hands-on guide for experimenting with the pipeline in a Codespace.

  • Step-by-step play session: bootstrap → run make pipeline → edit examples/calculation_input.xml → break it on purpose → poke the acoustic CLI → explore in a Python REPL.
  • A "Switching to the real schema" section covering the gitignored private/ workflow, why real-generated models go to private/models/ (drift gate + leak risk), and the generate/validate/compare commands against private/ paths.
  • Flags the caveat that acoustic pipeline imports the committed acoustic_dataset.models, so running the full pipeline on real models needs a deliberate, reviewed change.

Placed at the repo root (not under docs/) so it doesn't affect the strict MkDocs build.

🤖 Generated with Claude Code

A step-by-step guide for experimenting with the pipeline in a Codespace:
edit the example input, re-run the pipeline, poke the CLI/REPL. Includes a
section on switching to the real schema in private/ and the pipeline caveat.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://DeepBlueCLtd.github.io/python-party/pr-preview/pr-12/

Built to branch gh-pages at 2026-06-19 16:21 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

IanMayo pushed a commit that referenced this pull request Jun 20, 2026
…ivate-schema path

Fold in the hands-on bits from the PLAYGROUND.md proposal (#12):
- Adventure 1: edit examples/calculation_input.xml and re-run; break it
  on purpose to watch the gate reject invalid input with no stale artifact.
- Adventure 2: show serialize.to_xml in the REPL.
- Adventure 5 (new): point the CLI at the gitignored private/ real schema
  via generate/validate/compare, with the caveat that full pipeline imports
  the committed models.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant