Skip to content

docs(encoding): focus README on current functionality and usage - #162

Merged
loothero merged 1 commit into
mainfrom
docs/encoding-readme
Oct 3, 2026
Merged

loothero merged 1 commit into
mainfrom
docs/encoding-readme

Conversation

@loothero

@loothero loothero commented Oct 3, 2026 •

Copy link
Copy Markdown
Member

The encoding README mixed API documentation with implementation transfer history, old coverage accounting, and a link to a missing PROVENANCE.md. Rewrite it around the current Base64 encoder, with dependency setup, usage, output behavior, and organized development and benchmark commands.

Remove historical commentary and the broken provenance link. This changes only packages/encoding/README.md; production code and coverage inputs are unchanged.

Validation:

  • scarb fmt --workspace and scarb fmt --check --workspace passed.
  • Package and harness builds passed.
  • snforge test -p game_components_encoding_harness: 401 passed, 0 failed, 0 ignored, 0 filtered out.
  • All relative README links resolve; git diff --check passed.

Summary by CodeRabbit

  • Documentation
    • Updated package documentation with installation guidance, API behavior, supported inputs, output format, memory usage, and available encoding options.
    • Clarified development, testing, coverage, and gas benchmark workflows, including requirements for reliable comparisons.
    • Removed detailed claims about test metrics, implementation internals, benchmark provenance, and validation gates.

@loothero
loothero requested a review from starknetdev as a code owner October 3, 2026 12:30
Copilot AI balanced review requested due to automatic review settings October 3, 2026 12:30

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 3, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 070c23c3-ad33-4bfa-9f9a-9170ea202bb0
📥 Commits

Reviewing files that changed from the base of the PR and between fd4ed38 and b213f8b.

📒 Files selected for processing (1)
  • packages/encoding/README.md
 __________________________
< Needle. Haystack. Found. >
 --------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-03T12:34:08.114854Z b213f8b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

claude-opus-5-5-medium Code Review: b213f8b

lgtm

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

gpt-6.1-sol-high Code Review: b213f8b

lgtm

@loothero
loothero merged commit 66ce934 into main Oct 3, 2026
9 of 10 checks passed
@loothero
loothero deleted the docs/encoding-readme branch October 3, 2026 12:37
@codecov

codecov Bot commented Oct 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

2 participants