Skip to content

Commit c9edd49

Browse files
committed
docs: add mdBook setup with GitHub Pages deployment
- book.toml: mdBook config for nondominium docs site - documentation/SUMMARY.md: full TOC wiring all 50+ existing docs - .github/workflows/docs.yml: deploy on push to main via Actions - .gitignore: exclude /book/ build output
1 parent f22963a commit c9edd49

4 files changed

Lines changed: 182 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'documentation/**'
8+
- 'book.toml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- name: Install mdBook
27+
run: |
28+
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.43/mdbook-v0.4.43-x86_64-unknown-linux-gnu.tar.gz \
29+
| tar -xz --directory=/usr/local/bin
30+
31+
- name: Build book
32+
run: mdbook build
33+
34+
- name: Upload Pages artifact
35+
uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: book
38+
39+
deploy:
40+
needs: build
41+
runs-on: ubuntu-latest
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
steps:
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
# build
99
dist/
10+
/book/
1011
/target/
1112
/.cargo/
1213

@@ -36,6 +37,7 @@ dist/
3637
# PAI
3738
Plans/
3839
MEMORY/
40+
ISA.md
3941

4042
# git worktrees
4143
.worktrees/

book.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[book]
2+
title = "Nondominium Documentation"
3+
description = "Infrastructure for organization-agnostic, uncapturable, self-governed resources built on Holochain and ValueFlows."
4+
authors = ["Sensorica"]
5+
language = "en"
6+
src = "documentation"
7+
8+
[build]
9+
build-dir = "book"
10+
11+
[output.html]
12+
site-url = "/nondominium/"
13+
git-repository-url = "https://github.com/Sensorica/nondominium"
14+
edit-url-template = "https://github.com/Sensorica/nondominium/edit/main/documentation/{path}"
15+
no-section-label = false
16+
17+
[output.html.search]
18+
enable = true
19+
limit-results = 20
20+
teaser-word-count = 30

documentation/SUMMARY.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Summary
2+
3+
[Introduction](DOCUMENTATION_INDEX.md)
4+
5+
---
6+
7+
# Requirements
8+
9+
- [Requirements Overview](requirements/requirements.md)
10+
- [Agent Ontology](requirements/agent.md)
11+
- [Resource Ontology](requirements/resources.md)
12+
- [Governance Ontology](requirements/governance.md)
13+
- [NDO Prima Materia](requirements/ndo_prima_materia.md)
14+
- [UI Design](requirements/ui_design.md)
15+
16+
## Post-MVP Requirements
17+
18+
- [Complete Resource Specification](requirements/post-mvp/complete-resource-specification.md)
19+
- [Digital Resource Integrity](requirements/post-mvp/digital-resource-integrity.md)
20+
- [Many-to-Many Flows](requirements/post-mvp/many-to-many-flows.md)
21+
- [Resource Transport Flow Protocol](requirements/post-mvp/resource-transport-flow-protocol.md)
22+
- [Versioning](requirements/post-mvp/versioning.md)
23+
- [ValueFlows DSL](requirements/post-mvp/valueflows-dsl.md)
24+
- [Lobby DNA](requirements/post-mvp/lobby-dna.md)
25+
- [Unyt Integration](requirements/post-mvp/unyt-integration.md)
26+
- [Flowsta Integration](requirements/post-mvp/flowsta-integration.md)
27+
28+
---
29+
30+
# Technical Specifications
31+
32+
- [Technical Specifications](specifications/specifications.md)
33+
- [NDO v1 Architecture Design](specifications/ndo-v1-architecture-design.md)
34+
- [Architecture Components](ARCHITECTURE_COMPONENTS.md)
35+
- [UI Architecture](specifications/ui_architecture.md)
36+
- [VfAction Usage](specifications/VfAction_Usage.md)
37+
- [Protocol Bridge Specifications](specifications/protocol-bridge-specifications.md)
38+
- [API Reference](API_REFERENCE.md)
39+
40+
## Governance Specifications
41+
42+
- [Governance Specification](specifications/governance/governance.md)
43+
- [Governance Operator Architecture](specifications/governance/governance-operator-architecture.md)
44+
- [Governance Operator Implementation Guide](specifications/governance/governance-operator-implementation-guide.md)
45+
- [Cross-Zome API](specifications/governance/cross-zome-api.md)
46+
- [Private Participation Receipt](specifications/governance/private-participation-receipt.md)
47+
- [PPR Security Implementation](specifications/governance/PPR_Security_Implementation.md)
48+
49+
## Post-MVP Specifications
50+
51+
- [Lobby Architecture](specifications/post-mvp/lobby-architecture.md)
52+
- [ValueFlows DSL Specs](specifications/post-mvp/valueflows-dsl-specs.md)
53+
54+
---
55+
56+
# Zome Reference
57+
58+
- [Architecture Overview](zomes/architecture_overview.md)
59+
- [Person Zome](zomes/person_zome.md)
60+
- [Resource Zome](zomes/resource_zome.md)
61+
- [Governance Zome](zomes/governance_zome.md)
62+
63+
---
64+
65+
# hREA Integration
66+
67+
- [Overview](hREA/README.md)
68+
- [Integration Strategy](hREA/integration-strategy.md)
69+
- [Strategic Roadmap](hREA/strategic-roadmap.md)
70+
- [ValueFlows 1.0 Compliance](hREA/valueflows-1.0-compliance.md)
71+
72+
---
73+
74+
# Development
75+
76+
- [Implementation Plan](implementation_plan.md)
77+
- [Implementation Status](IMPLEMENTATION_STATUS.md)
78+
- [Development Report](development-report.md)
79+
- [Testing Infrastructure](Testing_Infrastructure.md)
80+
- [Test Commands](TEST_COMMANDS.md)
81+
82+
---
83+
84+
# Applications
85+
86+
- [Artcoin](Applications/artcoin_main_doc.md)
87+
- [Nondominium × Artcoin](Applications/nondominium_artcoin.md)
88+
- [Distributed Journalism](Applications/distributed_journalism.md)
89+
- [ERP Holochain Bridge](Applications/erp_holochain_bridge.md)
90+
- [HealthNet](Applications/healthnet.md)
91+
- [Strategic Development](Applications/strategic_development.md)
92+
93+
## User Stories
94+
95+
- [Artcoin](Applications/user-story/user-story-artcoin.md)
96+
- [Art Distribution](Applications/user-story/user-story-art-distribution.md)
97+
- [Art Production](Applications/user-story/user-story-art-production.md)
98+
- [ERP Bridge](Applications/user-story/user-story-ERP-bridge.md)
99+
- [Food Basket](Applications/user-story/user-story-food-basket.md)
100+
- [Material Peer Production](Applications/user-story/user-story-material-peer-production.md)
101+
- [Open Science](Applications/user-story/user-story-open-science.md)
102+
103+
---
104+
105+
# Research & Archives
106+
107+
- [P2P Models Comparison](archives/P2PMODELS_COMPARISON_REPORT.md)
108+
- [Nondominium Mutualization](archives/nondominium_mutualization.md)
109+
- [Fractal Composable Resource Architecture](archives/fractal-composable-resource-architecture.md)
110+
- [Digital Fabrics Concept](archives/digital_fabrics_concept_definition_2025-10-28.md)
111+
- [Holochain Storage Verification Patterns](archives/holochain-storage-verification-patterns.md)
112+
- [Complexity Oriented Programming](archives/complexity_oriented_programming.md)

0 commit comments

Comments
 (0)