Skip to content

fix: correct v1-reference docs (BIP-39 mnemonic and encrypted messaging) - #25

Merged
grunch merged 3 commits into
mainfrom
improve-docs
Mar 24, 2026
Merged

fix: correct v1-reference docs (BIP-39 mnemonic and encrypted messaging)#25
grunch merged 3 commits into
mainfrom
improve-docs

Conversation

@Catrya

@Catrya Catrya commented Mar 24, 2026

Copy link
Copy Markdown
Member
  • Fix mnemonic spec to use 12-word BIP-39 instead of 24
  • Remove fictional SessionFileCache section (never existed in code)
  • Rewrite Future Improvements with correct persistent caching approach (cache encrypted blobs, not decrypted)
  • Add download progress indication improvement
  • Update supported file types: images, documents (PDF/DOC/TXT), videos (MP4/MOV)

Summary by CodeRabbit

  • Documentation
    • Updated authentication documentation to reflect 12-word recovery phrase format for account backups
    • Clarified supported file formats for encrypted messaging: images (JPG, PNG, JPEG), documents (PDF, DOC, DOCX), and videos (MP4, MOV, AVI)
    • Documented upcoming download progress indication feature for improved file transfer visibility

Catrya added 2 commits March 24, 2026 11:45
  - Remove fictional SessionFileCache section (never existed in code)
  - Rewrite Future Improvements with correct persistent caching approach (cache encrypted blobs, not decrypted)
  - Add download progress indication improvement
  - Update supported file types: images, documents (PDF/DOC/TXT), videos (MP4/MOV)
@coderabbitai

coderabbitai Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@Catrya has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 61ae1243-55c6-4861-8a10-0d1c1736f83a

📥 Commits

Reviewing files that changed from the base of the PR and between 46f23a5 and 445f3d6.

📒 Files selected for processing (1)
  • .specify/v1-reference/AUTHENTICATION.md

Walkthrough

Two reference documentation files were updated: the first reducing BIP-39 mnemonic specification from 24 to 12 words across authentication flows, and the second revising supported file type formats, removing a persistent cache implementation plan, and replacing future improvement content with download progress indication specifications.

Changes

Cohort / File(s) Summary
Authentication Mnemonic Specification
.specify/v1-reference/AUTHENTICATION.md
Updated BIP-39 mnemonic length from 24-word to 12-word throughout first-run key generation flow, Secret Words Card UI description, KeyDerivator comment, and secure storage section.
Encrypted Image Messaging Documentation
.specify/v1-reference/ENCRYPTED_IMAGE_MESSAGING_IMPLEMENTATION.md
Revised supported file types (image formats to JPG/PNG/JPEG only; documents to PDF/DOC/DOCX; videos to MP4/MOV/AVI). Removed "Persistent Cache Implementation" TODO subsection entirely. Replaced future improvements content from proposed caching/NIP-98 specs to download progress indication using Stream<double> approach.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Twelve words now suffice for secrets kept,
Files pruned, their purposes adept,
Progress flows where caches once would stay,
Documentation blooms in fresh array!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately summarizes the main changes: correcting BIP-39 mnemonic documentation (24→12 words) and updating encrypted messaging implementation details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch improve-docs

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.specify/v1-reference/AUTHENTICATION.md:
- Line 48: The documentation line currently claims "Generate 12-word BIP-39
mnemonic (entropy: 256 bits)" which is inconsistent; update that line in
AUTHENTICATION.md so the word count and entropy match BIP-39 (either change to
"Generate 12-word BIP-39 mnemonic (entropy: 128 bits)" or to "Generate 24-word
BIP-39 mnemonic (entropy: 256 bits)" depending on the intended strength),
ensuring the mnemonic word count and entropy values align.

In @.specify/v1-reference/ENCRYPTED_IMAGE_MESSAGING_IMPLEMENTATION.md:
- Around line 9-11: Update the supported file types in both occurrences of the
file-type lists so they match the PR requirements: keep Images as "JPG, PNG,
JPEG", change Documents to include "PDF, DOC, TXT" (replace "DOCX" with "TXT"),
and change Videos to "MP4, MOV" (remove "AVI"); ensure the three headings
"**Images**", "**Documents**", "**Videos**" and their lists are identical in the
top section and the later section that currently contradicts it so both
locations reflect the same adjusted lists.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f66b1ec8-c4dd-462d-9347-2ac191996726

📥 Commits

Reviewing files that changed from the base of the PR and between 14a8878 and 46f23a5.

📒 Files selected for processing (2)
  • .specify/v1-reference/AUTHENTICATION.md
  • .specify/v1-reference/ENCRYPTED_IMAGE_MESSAGING_IMPLEMENTATION.md

Comment thread .specify/v1-reference/AUTHENTICATION.md Outdated
Comment thread .specify/v1-reference/ENCRYPTED_IMAGE_MESSAGING_IMPLEMENTATION.md
@grunch
grunch merged commit fba322b into main Mar 24, 2026
1 check passed
@grunch
grunch deleted the improve-docs branch March 24, 2026 19:28
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