[PR #5197] docs: add REA guide and architecture patterns aligned to 6.7.0 #6809

Open
opened 2026-11-01 21:43:10 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5197
Author: @ACISPRO1
Created: 10/19/2026
Status: 🔄 Open

Base: main ← Head: docs/evidence-model-and-patterns


📝 Commits (10+)

  • 0957d47 docs: align REA-GUIDE with 6.7.0 beta output
  • e8bac0b docs: correct evidence identity and ledger closure
  • daecf3c docs: state that listed unknown IDs block closure
  • b7a9fd5 Merge origin/main into docs/evidence-model-and-patterns
  • 7c59e9c Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns
  • 3423c4f Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns
  • 6495b0e docs: update Node.js prerequisites in REA guide
  • 5f6842a Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns
  • 4ea8c56 docs: match reconstruction-proof guidance to the evaluator
  • ecfe69d Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns

📊 Changes

10 files changed (+1484 additions, -0 deletions)

View changed files

📝 docs/.vitepress/config.ts (+2 -0)
➕ docs/architecture-patterns.md (+545 -0)
➕ docs/assets/adapter-pattern.jpg (+0 -0)
➕ docs/assets/factory-pattern.jpg (+0 -0)
➕ docs/assets/mediator-pattern.jpg (+0 -0)
➕ docs/assets/observer-pattern-v2.jpg (+0 -0)
➕ docs/assets/rea-evidence-model.jpg (+0 -0)
➕ docs/assets/singleton-pattern.jpg (+0 -0)
📝 docs/index.md (+1 -0)
➕ docs/rea-guide.md (+936 -0)

📄 Description

Summary

  • Add docs/rea-guide.md and docs/architecture-patterns.md covering the Evidence model, obligation ledger, and related architecture patterns.
  • Align obligation statuses, rol_ ledger ID prefix, and closure_digest semantics with observed REA 6.7.0 behavior.
  • Add diagrams under docs/assets/ and link the new pages from the VitePress sidebar and home page.

Notes

  • Local machine paths and testbed references have been removed or generalized.
  • Docs build fails on six pre-existing dead links into experiments/analysis-efficiency/ from other pages; the new pages do not add any.
  • npm run check:fast passed.

Author readiness

Human owner: @ACISPRO1

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/5197 **Author:** [@ACISPRO1](https://github.com/ACISPRO1) **Created:** 10/19/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/evidence-model-and-patterns` --- ### 📝 Commits (10+) - [`0957d47`](https://github.com/morluto/rea/commit/0957d472342997cf015e077481d2101f203625b2) docs: align REA-GUIDE with 6.7.0 beta output - [`e8bac0b`](https://github.com/morluto/rea/commit/e8bac0ba7482749558c2266fe5ab6d6e91cf1948) docs: correct evidence identity and ledger closure - [`daecf3c`](https://github.com/morluto/rea/commit/daecf3c41ac182f806b25e7cf3337494ab404085) docs: state that listed unknown IDs block closure - [`b7a9fd5`](https://github.com/morluto/rea/commit/b7a9fd55eee69ff230f62c884d60cc281dd3ec5f) Merge origin/main into docs/evidence-model-and-patterns - [`7c59e9c`](https://github.com/morluto/rea/commit/7c59e9cab65717831a85e83d30e607359c1869e0) Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns - [`3423c4f`](https://github.com/morluto/rea/commit/3423c4f6a8b9f34cd2b5e3f40f05c2a377044417) Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns - [`6495b0e`](https://github.com/morluto/rea/commit/6495b0ea87f2f83d93311d69de9d9bd9874da4e7) docs: update Node.js prerequisites in REA guide - [`5f6842a`](https://github.com/morluto/rea/commit/5f6842ac26492f976d560de213748f7ab5f4afc9) Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns - [`4ea8c56`](https://github.com/morluto/rea/commit/4ea8c569f616a38843477660ceb6ef2f3f170066) docs: match reconstruction-proof guidance to the evaluator - [`ecfe69d`](https://github.com/morluto/rea/commit/ecfe69de87c9d810449c399ce44ca8bf2fb5fdaa) Merge remote-tracking branch 'upstream/main' into docs/evidence-model-and-patterns ### 📊 Changes **10 files changed** (+1484 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/.vitepress/config.ts` (+2 -0) ➕ `docs/architecture-patterns.md` (+545 -0) ➕ `docs/assets/adapter-pattern.jpg` (+0 -0) ➕ `docs/assets/factory-pattern.jpg` (+0 -0) ➕ `docs/assets/mediator-pattern.jpg` (+0 -0) ➕ `docs/assets/observer-pattern-v2.jpg` (+0 -0) ➕ `docs/assets/rea-evidence-model.jpg` (+0 -0) ➕ `docs/assets/singleton-pattern.jpg` (+0 -0) 📝 `docs/index.md` (+1 -0) ➕ `docs/rea-guide.md` (+936 -0) </details> ### 📄 Description ## Summary - Add `docs/rea-guide.md` and `docs/architecture-patterns.md` covering the Evidence model, obligation ledger, and related architecture patterns. - Align obligation statuses, `rol_` ledger ID prefix, and `closure_digest` semantics with observed REA 6.7.0 behavior. - Add diagrams under `docs/assets/` and link the new pages from the VitePress sidebar and home page. ## Notes - Local machine paths and testbed references have been removed or generalized. - Docs build fails on six pre-existing dead links into `experiments/analysis-efficiency/` from other pages; the new pages do not add any. - `npm run check:fast` passed. ## Author readiness Human owner: @ACISPRO1 - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#6809
No description provided.