Render review stubs in the mdbook

[yuval-block]

Adds the stubs from #59 to the mdbook chapter index, and shorten their a six-month stale window to two weeks, because in hindsight seems a bit too long for stubs and we'd like to merge these by then.

[github-actions]

range-diff for force push a8d3359012 → cc12e02d62 October 17, 2026 15:07 UTC: 1 modified, 2 dropped

^{reproduce: git range-diff 32edbfe..a8d3359 32edbfe..cc12e02}

1:  b8bca35a57 ! 1:  cc12e02d62 [WIP] ████████████████████ Render review stubs with a two-week window
2:  300a2938d5 < -:  ---------- [WIP] ████████████████████ Order chapters and add an overview stub
3:  a8d3359012 < -:  ---------- [WIP] ████████████████████ Render review stubs with a two-week window

1: b8bca35a57 ! 1: cc12e02d62 [WIP] ████████████████████ Render review stubs with a two-week window

@@ Metadata
 Author: Yuval Kogman <nothingmuch@woobling.org>
 
  ## Commit message ##
-    [WIP] ████████████████████ Render review stubs with a two-week window
-
-    The chapters added by PR #59 need to appear in mdBook while their full
-    drafts remain under review. Register all four in src/SUMMARY.md using
-    the existing source-directory symlink convention, and shorten their
-    stale-after date to October 31, 2026, two weeks after October 17.
-
-    ---
-    - [x] Update the four stub dates.
-    - [x] Register the chapters using the existing source symlink convention.
-    - [x] Verify the rendered book.
+    Render review stubs with a two-week window
 
  ## docs/coalition_formation.md ##
 @@
@@ docs/cost_function_abstract.md
  
  # Cost function framework for Bitcoin wallets
 
+ ## docs/overview.md (new) ##
+@@
++---
++type: Stub
++title: Overview
++status: draft
++stale_after: 2026-10-31T00:00:00Z
++---
++
++# Overview
++
++This chapter is under review in [#51](https://github.com/fungi-protocol/docs/pull/51). Its draft is on [the pull request's branch](https://github.com/fungi-protocol/docs/blob/overview/docs/overview.md).
+
  ## docs/psbt-concurrent.md ##
 @@
  type: Stub
@@ src/SUMMARY.md
  
  [Introduction](README.md)
  
++- [Overview](docs/overview.md)
 +- [Collaborative transaction privacy](docs/collaborative_txn_privacy.md)
-+- [Concurrent PSBT Construction](docs/psbt-concurrent.md)
-+- [Cost function framework for Bitcoin wallets](docs/cost_function_abstract.md)
 +- [Market-based coalition formation for collaborative transaction construction](docs/coalition_formation.md)
++- [Cost function framework for Bitcoin wallets](docs/cost_function_abstract.md)
 +
  # BIP Drafts
  
++- [Concurrent PSBT Construction](docs/psbt-concurrent.md)
  - [PSBT Scrubber](bip-drafts/scrubber.md)
 
  ## src/docs (new) ##

[bc1cindy]

mdbook doesn't strip frontmatter, so it renders into each stub and the sidebar

#50 strips it in contrib/book.py (and requires it), and replaces the src/ symlinks and hand-written SUMMARY.md with a SUMMARY.md generated from docs/index.md, which already lists four of these stubs

so i think this makes sense after #50, adding overview and the order you want in docs/index.md

[yuval-block]

so i think this makes sense after #50, adding overview and the order you want in docs/index.md

yes sorry that was my intent, thanks for catching

[github-actions]

range-diff for force push cc12e02d62 → 420634d1ac October 17, 2026 15:59 UTC: 1 modified

^{reproduce: git range-diff 32edbfe..cc12e02 f1fd2bd..420634d}

1:  cc12e02d62 ! 1:  420634d1ac Render review stubs with a two-week window

1: cc12e02d62 ! 1: 420634d1ac Render review stubs with a two-week window

@@ docs/cost_function_abstract.md
  
  # Cost function framework for Bitcoin wallets
 
+ ## docs/index.md ##
+@@
+ okf_version: "0.2"
+ ---
+ 
+-# BIP Drafts
+-
+-* [PSBT Scrubber](bip-drafts/scrubber.md) - Which PSBT fields can be shared with trusted and untrusted parties such that privacy is preserved.
+-
+ # In Review
+ 
++* [Overview](overview.md) - Under review in #51.
+ * [Collaborative transaction privacy](collaborative_txn_privacy.md) - Under review in #7.
++* [Market-based coalition formation for collaborative transaction construction](coalition_formation.md) - Under review in #18.
+ * [Cost function framework for Bitcoin wallets](cost_function_abstract.md) - Under review in #15.
++
++# BIP Drafts
++
+ * [Concurrent PSBT Construction](psbt-concurrent.md) - Under review in #16.
+-* [Market-based coalition formation for collaborative transaction construction](coalition_formation.md) - Under review in #18.
++* [PSBT Scrubber](bip-drafts/scrubber.md) - Which PSBT fields can be shared with trusted and untrusted parties such that privacy is preserved.
+
  ## docs/overview.md (new) ##
 @@
 +---
@@ docs/psbt-concurrent.md
  ---
  
  # Concurrent PSBT Construction
-
- ## src/SUMMARY.md ##
-@@
- 
- [Introduction](README.md)
- 
-+- [Overview](docs/overview.md)
-+- [Collaborative transaction privacy](docs/collaborative_txn_privacy.md)
-+- [Market-based coalition formation for collaborative transaction construction](docs/coalition_formation.md)
-+- [Cost function framework for Bitcoin wallets](docs/cost_function_abstract.md)
-+
- # BIP Drafts
- 
-+- [Concurrent PSBT Construction](docs/psbt-concurrent.md)
- - [PSBT Scrubber](bip-drafts/scrubber.md)
-
- ## src/docs (new) ##
-@@
-+../docs
- \ No newline at end of file

[bc1cindy]

concept ACK

[bc1cindy]

ACK 420634d

[oakagent]

the branch's book.py drops the duplicate-chapter and generated-name checks that okf-index's book.py has, so a repeated chapter or a root contents.md/SUMMARY.md page is accepted; should the branch carry those checks, @yuval-block?

[arminsabouri]

heads up Some conflicts here to resolve

[yuval-block]

the branch's book.py drops the duplicate-chapter and generated-name checks that okf-index's book.py has

sloppy rebase on my part

The base branch was changed.

[github-actions]

range-diff for force push 420634d1ac → dc7633d5e5 October 19, 2026 22:09 UTC: 1 unchanged, 3 dropped

^{reproduce: git range-diff 32edbfe..420634d b3e699e..dc7633d}

1:  8aef0c4f08 < -:  ---------- Generate SUMMARY.md from an OKF index.md
2:  42257c75b3 < -:  ---------- Point links out of the book at the repository
3:  f1fd2bd6d8 < -:  ---------- Check the status and stale_after of chapters
4:  420634d1ac = 1:  dc7633d5e5 Render review stubs with a two-week window