docs: add whitepaper/litepaper PDFs and implementation-status record#1
Merged
Conversation
The contracts cite "whitepaper §X" throughout their NatSpec, but the cited document was not in the repo. Add both PDFs (matching the canonical names served at reineira.xyz) under docs/, plus: - docs/IMPLEMENTATION-STATUS.md — honest readiness record mapping shipped / partial / planned to whitepaper sections, so the spec-vs-code relationship is explicit. Discloses current gaps deliberately: recourse underwriter policy and LP reward accounting are stubs; orchestration and operators are in progress; nothing is audited. - docs/README.md — documentation index. Link all three from the root README. Status is also intended to be published in product language in the whitepaper and on docs.reineira.xyz. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
grimnote
requested review from
0xkkkn,
VladVelik,
jishumi,
madschristensen99 and
vergil-dv
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The contracts cite
whitepaper §Xthroughout their NatSpec, but the cited document was not in the repo. This PR adds it and makes protocol readiness explicit.docs/ReineiraOS-Whitepaper.pdf,docs/ReineiraOS-Litepaper.pdf— the papers, matching the canonical filenames served at reineira.xyz. The in-repo copy is the snapshot the code in this commit was written against.docs/IMPLEMENTATION-STATUS.md— an honest, roadmap-framed readiness record mapping shipped / partial / planned to whitepaper sections, so the spec-vs-code relationship is explicit rather than assumed. Disclosed gaps: recourse underwriter policy and LP reward accounting are stubs; orchestration and operators are in progress; nothing is audited.docs/README.md— documentation index.README.md— new Documentation section linking all three.The same readiness picture is intended to be mirrored, in product language, in the whitepaper (Implementation Status note) and on docs.reineira.xyz (status page) as follow-ups.
Type of Change
Packages Affected
None — docs only.
Testing
prettier --check(the format gate in CI)Security Considerations
None. Docs-only change; no access control, FHE, or fund-handling code is touched. (The status doc deliberately discloses that no contract here is audited.)
🤖 Generated with Claude Code