diff options
| author | Nick Mathewson <nickm@torproject.org> | 2023-10-18 12:17:04 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2023-10-18 12:17:04 -0400 |
| commit | ad21edb7445d43ea140937fba9b1bab37dec6086 (patch) | |
| tree | 03475a09a3fc111217483eab0a503b90d7dab06f /spec/README.md | |
| parent | 09e0111311507e036afacb8783884da511cd85a4 (diff) | |
| download | torspec-ad21edb7445d43ea140937fba9b1bab37dec6086.tar.gz torspec-ad21edb7445d43ea140937fba9b1bab37dec6086.zip | |
Use a different example file in the README.
Diffstat (limited to 'spec/README.md')
| -rw-r--r-- | spec/README.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/spec/README.md b/spec/README.md index 9bea38b..cdf51ad 100644 --- a/spec/README.md +++ b/spec/README.md @@ -32,7 +32,7 @@ as we like. We have broken it into a few major sections. For a table of contents, click on the menu icon to the top-left of your browser scene. You should probably start by reading [the core -tor protocol specification](./tor-spec-intro), which describes how our +tor protocol specification](./tor-spec), which describes how our protocol works. After that, you should be able to jump around to the topics that interest you most. The introduction of each top-level chapter should provide an introduction. @@ -46,8 +46,9 @@ its documentation. To edit these specs, clone the [git repository] and edit the appropriate file in the [`spec` directory]. These files will match the URLs of their corresponding pages, so if you want to edit -[`tor-spec-intro.html`](./tor-spec-intro), you'll be looking for a file -called [`spec/tor-spec-intro.md`]. +[`tor-spec/flow-control.html`](./tor-spec/flow-control), +you'll be looking for a file +called [`spec/tor-spec/flow-control.md`]. The chapter structure as a whole is defined in a special file called [`SUMMARY.md`]. Its format is pretty restrictive; see the [mdbook @@ -149,6 +150,6 @@ long-term permalinks. [git repository]: https://gitlab.torproject.org/tpo/core/torspec/ [heading ids]: https://github.com/raphlinus/pulldown-cmark/blob/master/specs/heading_attrs.txt [mdbook documentation]: https://rust-lang.github.io/mdBook/format/summary.html -[`spec/tor-spec-intro.md`]: https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/spec/tor-spec-intro.md?ref_type=heads +[`spec/tor-spec/flow-control.md`]: https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/spec/tor-spec/flow-control.md?ref_type=heads [`spec` directory]: https://gitlab.torproject.org/tpo/core/torspec/-/tree/main/spec?ref_type=heads [`summary.md`]: https://gitlab.torproject.org/tpo/core/torspec/-/raw/main/spec/SUMMARY.md?ref_type=heads |