Skip to content

docs: comprehensive documentation update#14

Merged
mpecan merged 1 commit intomainfrom
docs/update-documentation
Mar 25, 2026
Merged

docs: comprehensive documentation update#14
mpecan merged 1 commit intomainfrom
docs/update-documentation

Conversation

@mpecan
Copy link
Copy Markdown
Owner

@mpecan mpecan commented Mar 25, 2026

Summary

  • README.md: Added CI/crates.io/docs.rs/PyPI/license badges, API reference section (parse signature, AST types table, error types), complete justfile command reference (including fuzzing, oracle, and Python commands), testing section with corpus/oracle/fuzzing details, architecture data flow diagram, clone instructions, and links to examples/docs.rs
  • CONTRIBUTING.md: Added full project structure with all sub-modules, fuzzing guide, oracle testing section, CI overview, per-file test running tips, and requirements section
  • CLAUDE.md: Updated architecture table to match current module layout (lexer/, parser/, sexp/ sub-modules, context.rs, oracle tests)

Test plan

  • All 134 tests pass (cargo test --all-targets)
  • Verify badge URLs resolve correctly after merge
  • Spot-check that justfile commands listed in docs match actual justfile

🤖 Generated with Claude Code

- Add CI, crates.io, docs.rs, PyPI, and license badges to README
- Add API reference section with parse() signature, AST types table, and error types
- Add complete justfile command reference (fuzzing, oracle, Python, cleanup)
- Add testing section covering test corpus, oracle tests, and differential fuzzing
- Add architecture data flow diagram
- Add clone instructions to quick start
- Update architecture table with all current modules (context.rs, error.rs, token.rs)
- Update CONTRIBUTING.md with full project structure, fuzzing guide, CI details
- Update CLAUDE.md architecture to match current module layout
- Link to examples/basic.rs and docs.rs for deeper exploration

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mpecan mpecan merged commit 6abfb20 into main Mar 25, 2026
5 checks passed
@mpecan mpecan deleted the docs/update-documentation branch March 25, 2026 15:39
mpecan added a commit that referenced this pull request Mar 25, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.1.8](rable-v0.1.7...rable-v0.1.8)
(2026-03-25)


### Features

* enrich AST with structured word spans and assignment detection
([9163d24](9163d24))
* enrich AST with structured word spans and assignment detection
([#11](#11))
([3b58c38](3b58c38))


### Bug Fixes

* CTLESC byte doubling for bash-oracle compatibility (179/181)
([72bc381](72bc381))
* heredoc trailing newline at EOF with backslash (180/181)
([4af8d91](4af8d91))
* resolve 11 oracle test failures (180/181)
([#13](#13))
([69d6bc8](69d6bc8))
* resolve 3 more oracle failures (177/181)
([8aca953](8aca953))
* resolve 6 oracle test failures
([0496222](0496222))
* resolve 6 oracle test failures (175/181)
([1708884](1708884))


### Documentation

* comprehensive documentation update
([#14](#14))
([6abfb20](6abfb20))
* comprehensive documentation update for better DX
([61114b0](61114b0))


### Code Refactoring

* remove sexp re-parsing by threading spans through all nodes
([54db8c7](54db8c7))
* simplify span collection, move to owned tokens, remove dead code
([cec7e8e](cec7e8e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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