Skip to content

Document the current theme packages and Rust usage - #16

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

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 used future-tense ownership, did not show how to consume the Rust catalog, and left generated package READMEs on older catalog versions. It also did not distinguish the published Cargo crate from the repository-only JavaScript package tree.

Implementation Approach

  • Describe current repository ownership in the present tense.
  • Add a minimal stack-theme catalog example and docs.rs link.
  • State which artifact is publicly distributed and how browser consumers receive the catalog.
  • Synchronize the Cargo and JavaScript package READMEs with catalog 0.6.0.

Testing Approach

  • npm run validate
  • npm run generate:check
  • npm test
  • npm run typecheck
  • cargo test --workspace --locked
  • cargo doc --workspace --no-deps --locked
  • Compiled and ran the README example in an isolated Cargo project.

Review Perspectives / Points of Concern

Please verify that the distribution section clearly distinguishes generated package parity from a standalone public npm release.

@konojunya
konojunya merged commit 241fdd2 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