Skip to content

Commit ab23be5

Browse files
committed
docs: polish README
1 parent ec05aa0 commit ab23be5

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
Pilot Protocol design documents — the source of truth for what the
44
protocol does, why it does it that way, and how to operate it.
55

6-
User-facing docs (getting started, tutorials, API references) live
7-
on the website at [pilotprotocol.network](https://pilotprotocol.network).
6+
User-facing documentation (getting started, tutorials, API references)
7+
lives on the website at [pilotprotocol.network](https://pilotprotocol.network).
88
This repo is the protocol-internal counterpart: deeper specs, IETF
99
drafts, runbooks, and academic-style writeups.
1010

1111
## Layout
1212

1313
| Path | What it is |
1414
|---|---|
15-
| `SPEC.md` | The canonical protocol spec — addresses, frame format, layered architecture. |
16-
| `SPEC-compat-mode.md` | How compat mode (TLS/443) layers on top of the native UDP path. |
15+
| `SPEC.md` | Canonical protocol spec — addresses, frame format, layered architecture. |
16+
| `SPEC-compat-mode.md` | Compat mode (TLS/443) layered on top of the native UDP path. |
1717
| `SPEC-skillinject-openclaw-per-prompt.md` | Spec for the skillinject plugin's per-prompt injection. |
1818
| `RUNBOOK-pilot-ca.md` | Root-CA ceremony procedure — key generation, rotation, audit. |
1919
| `RUNBOOK-compat-443-only.md` | Operating a daemon when only port 443 is reachable. |
@@ -25,12 +25,12 @@ drafts, runbooks, and academic-style writeups.
2525
| `ietf/` | IETF draft text + Makefile. |
2626
| `research/comparison/` | Comparison paper vs. other overlay protocols. |
2727
| `research/social-structures/` | Trust-network social-structure paper. |
28-
| `media/` | Diagrams + screencasts referenced by other docs. |
28+
| `media/` | Diagrams and screencasts referenced by other docs. |
2929

3030
## Building TeX → PDF
3131

32-
Each `.tex` is built with `pdflatex` (twice for cross-refs). The
33-
`ietf/` drafts use `kramdown-rfc` via the Makefile there.
32+
Each `.tex` is built with `pdflatex` (run twice for cross-references).
33+
The `ietf/` drafts use `kramdown-rfc` via the Makefile there.
3434

3535
```bash
3636
cd ietf && make

0 commit comments

Comments
 (0)