Skip to content

Commit 80f594f

Browse files
docs: rename book/ to docs/
1 parent 5e9bc53 commit 80f594f

19 files changed

Lines changed: 24 additions & 21 deletions

.github/workflows/docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches: [main]
66
paths:
7-
- "book/**"
7+
- "docs/**"
88
- "README.md"
99
- "CONTRIBUTING.md"
1010
- "SECURITY.md"
@@ -40,13 +40,13 @@ jobs:
4040
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
4141
4242
- name: Build book
43-
run: mdbook build book
43+
run: mdbook build docs
4444

4545
- uses: actions/configure-pages@v5
4646

4747
- uses: actions/upload-pages-artifact@v3
4848
with:
49-
path: book/book
49+
path: docs/html
5050

5151
deploy:
5252
needs: build

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
/target
2-
/book/book
2+
/docs/html

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Initial release: a working, tested, testnet-deployed assertion and dispute oracl
1919
paused.
2020
- `contracts/demo-consumer`: a minimal example contract calling into Tholos,
2121
validating the cross-contract integration pattern documented in
22-
[INTEGRATION.md](book/src/INTEGRATION.md) against Tholos's real compiled wasm.
22+
[INTEGRATION.md](docs/src/INTEGRATION.md) against Tholos's real compiled wasm.
2323
- `scripts/testnet-smoke.sh`: an end-to-end check against real Stellar testnet
2424
infrastructure (deploy, initialize, assert, dispute, resolve).
2525
- CI (`fmt`, `clippy`, `test`, wasm build) on every push and pull request.

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ contracts/
2828
test.rs Unit tests (soroban-sdk testutils, mocked ledger and auth)
2929
demo-consumer/ Minimal example contract that calls into Tholos
3030
src/
31-
lib.rs Cross-contract call pattern from book/src/INTEGRATION.md
31+
lib.rs Cross-contract call pattern from docs/src/INTEGRATION.md
3232
test.rs Validates that pattern against Tholos's real compiled wasm
3333
scripts/
3434
testnet-smoke.sh End-to-end check against real Stellar testnet infrastructure
3535
.github/workflows/
3636
ci.yml Runs fmt, clippy, tests, and the wasm build on every push/PR
3737
```
3838

39-
`demo-consumer` exists to keep [INTEGRATION.md](book/src/INTEGRATION.md) honest: it's not a product, it's a
39+
`demo-consumer` exists to keep [INTEGRATION.md](docs/src/INTEGRATION.md) honest: it's not a product, it's a
4040
compiled check that the documented integration pattern actually works. If you
4141
change Tholos's public interface, update `demo-consumer` too if it uses the
4242
changed function, and re-run its test.
@@ -80,7 +80,7 @@ There are two layers, and they catch different things:
8080

8181
## Docs site
8282

83-
`book/` is an [mdBook](https://rust-lang.github.io/mdBook/) that publishes this
83+
`docs/` is an [mdBook](https://rust-lang.github.io/mdBook/) that publishes this
8484
repo's docs as a site, deployed automatically from `main` by
8585
`.github/workflows/docs.yml`. Where a given doc's real content lives depends on
8686
whether GitHub treats it specially:
@@ -89,15 +89,15 @@ whether GitHub treats it specially:
8989
stay at the repo root, because GitHub does something with them there (README
9090
renders on the repo homepage, CONTRIBUTING is linked when opening an issue/PR,
9191
SECURITY.md powers the Security tab, and CHANGELOG.md is close enough to a
92-
universal convention to keep at root regardless). Their `book/src/` copies are
92+
universal convention to keep at root regardless). Their `docs/src/` copies are
9393
one-line `\{{#include ../../X.md}}` stubs; edit the root file, not the stub.
9494
- `ARCHITECTURE.md`, `CONTRACT.md`, `DEPLOYMENT.md`, `GLOSSARY.md`, and
9595
`INTEGRATION.md` get no special treatment from GitHub at root, so their real
96-
content lives directly under `book/src/`, with no root duplicate. Edit them
96+
content lives directly under `docs/src/`, with no root duplicate. Edit them
9797
there; they're still normal markdown files GitHub renders fine if you click into
98-
`book/src/CONTRACT.md` directly, they just aren't at the repo's top level.
98+
`docs/src/CONTRACT.md` directly, they just aren't at the repo's top level.
9999

100-
Preview locally with `mdbook serve book` (requires `cargo install mdbook`).
100+
Preview locally with `mdbook serve docs` (requires `cargo install mdbook`).
101101

102102
## Before opening a PR
103103

@@ -112,7 +112,7 @@ cargo test
112112
```
113113

114114
If you changed the contract's public interface (functions, types, errors), update
115-
[CONTRACT.md](book/src/CONTRACT.md) to match; it's meant to stay in sync with
115+
[CONTRACT.md](docs/src/CONTRACT.md) to match; it's meant to stay in sync with
116116
`lib.rs`, not drift into a separate design doc.
117117

118118
## Commit messages

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ The assertion and dispute contract (`contracts/tholos`) is implemented, tested,
1919
- CI (fmt, clippy, tests, wasm build): done
2020
- Fee-funded reward for uncontested finalizes: not yet (no fee-generating market layer exists to fund it)
2121

22-
See [CONTRACT.md](book/src/CONTRACT.md) for the full interface and known gaps,
23-
[ARCHITECTURE.md](book/src/ARCHITECTURE.md) for design rationale, or
24-
[INTEGRATION.md](book/src/INTEGRATION.md) if you're building a contract that wants
22+
See [CONTRACT.md](docs/src/CONTRACT.md) for the full interface and known gaps,
23+
[ARCHITECTURE.md](docs/src/ARCHITECTURE.md) for design rationale, or
24+
[INTEGRATION.md](docs/src/INTEGRATION.md) if you're building a contract that wants
2525
to call into Tholos. Deploying your own instance: see
26-
[DEPLOYMENT.md](book/src/DEPLOYMENT.md). New to the terminology: see
27-
[GLOSSARY.md](book/src/GLOSSARY.md).
26+
[DEPLOYMENT.md](docs/src/DEPLOYMENT.md). New to the terminology: see
27+
[GLOSSARY.md](docs/src/GLOSSARY.md).
2828

2929
## Why
3030

@@ -43,7 +43,7 @@ stateDiagram-v2
4343
Resolved --> [*]
4444
```
4545

46-
A bond gets posted, a window gives anyone the chance to dispute it, and if disputed, a resolver committee votes to decide who was right. See [CONTRACT.md](book/src/CONTRACT.md) for the function reference and events, or [ARCHITECTURE.md](book/src/ARCHITECTURE.md) for sequence diagrams of each flow.
46+
A bond gets posted, a window gives anyone the chance to dispute it, and if disputed, a resolver committee votes to decide who was right. See [CONTRACT.md](docs/src/CONTRACT.md) for the function reference and events, or [ARCHITECTURE.md](docs/src/ARCHITECTURE.md) for sequence diagrams of each flow.
4747

4848
## Tech stack
4949

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Tholos has not had an external security audit. It has undergone one internal
66
review pass, which found and fixed a real reentrancy vulnerability (see
77
[CHANGELOG.md](CHANGELOG.md) and the "Security notes" section of
8-
[CONTRACT.md](book/src/CONTRACT.md)). Treat it as pre-production software: appropriate for
8+
[CONTRACT.md](docs/src/CONTRACT.md)). Treat it as pre-production software: appropriate for
99
testnet use and further review, not for deployments securing meaningful value on
1010
mainnet until it has been audited.
1111

book/book.toml renamed to docs/book.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ authors = ["drydocs"]
55
language = "en"
66
src = "src"
77

8+
[build]
9+
build-dir = "html"
10+
811
[output.html]
912
git-repository-url = "https://github.com/drydocs/tholos"
10-
edit-url-template = "https://github.com/drydocs/tholos/edit/main/book/{path}"
13+
edit-url-template = "https://github.com/drydocs/tholos/edit/main/docs/{path}"
1114
additional-js = ["mermaid.min.js", "mermaid-init.js"]
1215

1316
[preprocessor]
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)