You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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) ##
yuval-block
changed the title
Render review stubs and shorten their stale-after window
Render review stubs in the mdbook
Oct 17, 2026
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
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
The reason will be displayed to describe this comment to others. Learn more.
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?
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
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
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.
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.