Skip to content

docs: add Mina Protocol RFCs to researchers section #1999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
dannywillems wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

docs: add Mina Protocol RFCs to researchers section #1999

dannywillems wants to merge 3 commits into from

Conversation

@dannywillems
Copy link
Member

@dannywillems dannywillems commented Dec 20, 2025

Summary

  • Add all 65 RFCs from the MinaProtocol/mina repository to the website's
    researchers section
  • Each RFC includes Docusaurus frontmatter with title, sidebar label, and link
    to original GitHub source
  • RFCs organized into 10 categories: protocol/consensus, state management,
    networking, APIs, hard forks, zkApps, security, serialization, account
    features, infrastructure, and development processes
  • Updated docusaurus.config.ts to use format: detect for markdown files
  • Updated sidebars.ts to use autogenerated navigation for the RFCs category

Test plan

  • Ran make docs-build - website builds successfully
  • Verified all RFC links resolve correctly
  • Verified links to original GitHub sources work

@dannywillems
docs: add Mina Protocol RFCs to researchers section
cd30d28 
Add all 65 RFCs from the MinaProtocol/mina repository to the website's
researchers section. Each RFC includes:

- Docusaurus frontmatter with title and sidebar label
- Link to the original source on GitHub
- format: md to prevent MDX parsing issues with code blocks

The RFCs are organized into categories: protocol/consensus, state
management, networking, APIs, hard forks, zkApps, security, serialization,
account features, infrastructure, and development processes.

Updated docusaurus.config.ts to use format: detect for markdown files
and sidebars.ts to use autogenerated navigation for the RFCs category.
@github-actions
Copy link

github-actions bot commented Dec 20, 2025 •
edited
Loading

OCaml Reference Validation Results

Repository: https://github.com/MinaProtocol/mina.git
Branch: compatible
Status: ❌ Validation failed

Click to see full validation output 
Checking OCaml references against https://github.com/MinaProtocol/mina.git (branch: compatible)
Fetching current commit from compatible...
Current OCaml commit: ab534323696b0fd8918c77a95725088003727ef1

Validating references...
========================
✓ VALID: crates/ledger/src/account/account.rs -> src/lib/mina_base/account.ml L:201-224
  ⚠ STALE COMMIT: fc6be4c58091c761f827c858229c2edf9519e941 (current: ab534323696b0fd8918c77a95725088003727ef1)
❌ INVALID: crates/ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2285-2285 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2285-L2285
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2285-L2285
❌ INVALID: crates/ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2351-2356 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2351-L2356
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2351-L2356
❌ INVALID: crates/ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2407 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2407-L2407
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2407-L2407
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/transaction_status.ml L:9-51
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/transaction_status.ml L:452-454
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/with_status.ml L:6-10
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/fee_transfer.ml L:76-80
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/fee_transfer.ml L:68-69
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/coinbase.ml L:17-21
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/transaction/transaction.ml L:8-11
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:34-48
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/stake_delegation.ml L:11-13
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:179-181
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:239-243
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)
✓ VALID: crates/ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:352-362
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: ab534323696b0fd8918c77a95725088003727ef1)

Summary
=======
Total references found: 16
Valid references: 13
Invalid references: 3
Stale commits: 13

❌ Validation failed: 3 invalid reference(s) found

@github-actions
Copy link

github-actions bot commented Dec 20, 2025 •
edited
Loading

⚠️ Code Reference Verification Failed

The documentation contains code references that do not match the current state of the codebase on the develop branch.

Issues Found

  • website/docs/developers/referencing-code-in-documentation.md:36 - File not found: ledger/src/scan_state/transaction_logic/valid.rs

Action Required

The code referenced in the documentation must be merged to develop before documentation can be added/modified.

Please follow this workflow:

  1. Merge the code changes to develop first (this PR or a separate code PR)
  2. Create a follow-up PR with the documentation updates that reference the merged code
  3. The verification will pass once the code is available on develop

See the documentation guidelines for more information about the two-PR workflow.

@dannywillems dannywillems self-assigned this Dec 20, 2025
@dannywillems dannywillems moved this to In Review in Rust node Dec 20, 2025
@dannywillems
CI/md: pin prettier to exact version 3.7.4
65fc200 
Use exact version instead of range (^3.0.0) to ensure consistent
formatting between local development and CI environments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@richardpringle richardpringle Awaiting requested review from richardpringle

At least 1 approving review is required to merge this pull request.

Assignees

@dannywillems dannywillems

Labels

no changelog

Projects

Rust node
Status: In Review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dannywillems