Skip to content

Make the compiler README easier to adopt - #14

Merged
konojunya merged 1 commit into
mainfrom
agent/reader-first-readme
Sep 6, 2026
Merged

Make the compiler README easier to adopt#14
konojunya merged 1 commit into
mainfrom
agent/reader-first-readme

Conversation

@konojunya

@konojunya konojunya commented Sep 6, 2026

Copy link
Copy Markdown
Member

Background

The README explained the compiler pipeline and maintainer checks, but did not clearly identify the intended library audience or show the smallest API integration.

Implementation Approach

  • Clarify when to use the compiler crate versus the CLI or Playground.
  • Add a copyable compile example that produces normalized IR.
  • Link directly to the published docs.rs API.
  • Keep release instructions with the maintainer commands.

Testing Approach

  • cargo test --workspace
  • cargo doc --workspace --no-deps
  • Compiled and ran the README example in an isolated Cargo project.
  • Checked local Markdown links and whitespace.

Review Perspectives / Points of Concern

Please verify that the example demonstrates the renderer-independent boundary without implying that this crate renders diagrams.

@konojunya
konojunya merged commit cb04208 into main Sep 6, 2026
2 checks passed
@konojunya
konojunya deleted the agent/reader-first-readme branch September 6, 2026 03:54
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