Skip to content

Update readme#17

Merged
eacet merged 2 commits intomainfrom
fix/update-readme-content
Feb 24, 2026
Merged

Update readme#17
eacet merged 2 commits intomainfrom
fix/update-readme-content

Conversation

@eacet
Copy link
Copy Markdown
Member

@eacet eacet commented Feb 24, 2026

Summary

Package(s)

Languages

  • TypeScript
  • Rust

Checklist

  • Tests pass for all modified packages
  • Linting/formatting passes (biome check, cargo fmt)
  • Both language implementations are consistent (or noted as follow-up)
  • Package README updated if public API changed
  • No unnecessary dependencies added

Related Issues

Copy link
Copy Markdown
Member Author

eacet commented Feb 24, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Feb 24, 2026

Greptile Summary

Documentation-only PR that updates project messaging to reflect the current state of the monorepo. Key changes include adding Python as a planned third language across the directory structure and CI pipeline, updating the README's positioning to remove "pure language / no C bindings" claims in favor of "NIST-standardized / Production-ready", adding honesty caveats about package readiness (version guide, scaffolded-only warnings), and simplifying the pq-key-encoder Rust README to drop the "zero-dependency" claim.

  • CONTRIBUTING.md: test-data/ directory removed from the package structure diagram but it still exists and is actively used by test files — new contributors may miss it
  • README.md: BibTeX citation year = {2025-2026} is invalid syntax that will break citation tools
  • CLAUDE.md: Package count accurately updated from 37 to 39
  • CHANGELOG.md: New placeholder file pointing to GitHub Releases

Confidence Score: 4/5

  • Documentation-only PR with no code changes; safe to merge after addressing the BibTeX syntax issue and the missing test-data directory in the contributor guide.
  • This is a documentation-only PR with no functional code changes, making it inherently low-risk. Two minor issues were found: an invalid BibTeX year field and a misleading directory tree that omits the actively-used test-data/ directory. Neither will cause runtime failures, but both reduce documentation accuracy.
  • README.md (invalid BibTeX) and CONTRIBUTING.md (incomplete directory tree)

Important Files Changed

Filename Overview
CHANGELOG.md New changelog placeholder file. Minimal content pointing to GitHub Releases for per-package history. No issues.
CLAUDE.md Package count updated from 37 to 39, consistent with actual directory count. No issues.
CONTRIBUTING.md Updated to tri-language layout with Python structure and PyPI publish tag. However, test-data/ directory was removed from the tree diagram despite still being actively used in the codebase, and the prerequisites table lacks Python toolchain info.
README.md Significant updates to messaging: removed "pure language / no C bindings" claims, added Python scaffolding notes, clarified package readiness. BibTeX year field uses invalid 2025-2026 value that will break citation parsers.
packages/pq-key-encoder/rust/README.md Simplified description by removing the "zero-dependency*" claim and asterisk footnote. More accurate given actual dependencies on pq-oid and zeroize. No issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md] -->|updated messaging| B[Remove pure-language claims]
    A -->|added| C[Python scaffolding notes]
    A -->|added| D[Package readiness caveats]
    A -->|changed| E["BibTeX year: 2025→2025-2026 ⚠️"]
    F[CONTRIBUTING.md] -->|updated| G[tri-language layout]
    F -->|added| H[Python directory structure]
    F -->|removed| I["test-data/ from tree ⚠️"]
    F -->|added| J[PyPI publish tag]
    K[CLAUDE.md] -->|updated| L["Package count: 37→39"]
    M[pq-key-encoder/rust/README.md] -->|simplified| N[Remove zero-dependency claim]
    O[CHANGELOG.md] -->|new file| P[Placeholder pointing to GH Releases]
Loading

Last reviewed commit: 11a0bab

Copy link
Copy Markdown

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

@eacet eacet merged commit d7f3384 into main Feb 24, 2026
2 checks passed
@eacet eacet deleted the fix/update-readme-content branch February 24, 2026 16:26
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