Skip to content

Update documentation#17

Open
emmapowers wants to merge 3 commits into
modernize/5-ctiny-codegenfrom
modernize/6-documentation
Open

Update documentation#17
emmapowers wants to merge 3 commits into
modernize/5-ctiny-codegenfrom
modernize/6-documentation

Conversation

@emmapowers

Copy link
Copy Markdown
Owner

Summary

  • Add CLAUDE.md with project instructions
  • Update Python docs with async examples and messages() API
  • Update version requirement to Python 3.13+
  • Add runtime generation steps to quickstart
  • Rewrite protocol specification with Unicode diagrams, quick reference table, and grammar reference
  • Remove unimplemented "Not for V1" sections from spec
  • Update CLAUDE.md with project purpose, architecture, and coverage requirements

Test plan

  • Docs render correctly with mkdocs
  • No broken links

@coderabbitai

coderabbitai Bot commented Apr 14, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 38c20c6c-3bec-4a1e-807a-572261da56fa

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands and usage tips.

@emmapowers emmapowers force-pushed the modernize/6-documentation branch from 937095c to c4dead1 Compare April 14, 2026 14:46
@emmapowers emmapowers force-pushed the modernize/5-ctiny-codegen branch 2 times, most recently from 2801c4b to 3e6d258 Compare April 14, 2026 14:53
@emmapowers emmapowers force-pushed the modernize/6-documentation branch from c4dead1 to 4680779 Compare April 14, 2026 14:53
- Add CLAUDE.md with project instructions
- Update Python docs with async examples and messages() API
- Update version requirement to Python 3.13+
- Add runtime generation steps to quickstart
- Update .gitignore for Pixi and generated files
- Replace HTML tables with Unicode box-drawing diagrams
- Remove unimplemented "Not for V1" sections
- Add quick reference table and grammar reference
- Reorganize into clearer structure
Add purpose, target platforms, architecture, and design constraints
sections. Update project structure to include templates, runtimes, and
examples. Add 80% code coverage requirement for all target languages.
Fix typos and remove duplicate line.
@emmapowers emmapowers force-pushed the modernize/5-ctiny-codegen branch from 3e6d258 to 6140430 Compare April 14, 2026 15:34
@emmapowers emmapowers force-pushed the modernize/6-documentation branch from 4680779 to 6a64334 Compare April 14, 2026 15:34
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