diff options
| author | Nick Mathewson <nickm@torproject.org> | 2023-11-02 11:56:02 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2023-11-02 11:56:02 -0400 |
| commit | 7fbccfbef33ea655aba5536558d61b86156db239 (patch) | |
| tree | 8e2cc8ec7c5224692e9252fc4fca086f7e74243b /spec/README.md | |
| parent | d2d553175965dda5252840d5d6dd4834c6b04032 (diff) | |
| download | torspec-7fbccfbef33ea655aba5536558d61b86156db239.tar.gz torspec-7fbccfbef33ea655aba5536558d61b86156db239.zip | |
Add a quick and dirty style guide
This is not meant to be final by any means, but to be a starting
point to collect the conventions we develop as we improve our
documentation.
Diffstat (limited to 'spec/README.md')
| -rw-r--r-- | spec/README.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/spec/README.md b/spec/README.md index 3fd62ac..0686384 100644 --- a/spec/README.md +++ b/spec/README.md @@ -58,6 +58,10 @@ You can build the website locally to see how it renders. To do this, just install mdbook and run the `./bin/build_html.sh` script. (You will need to have mdbook installed to do this.) +We have started a [style guide](./STYLE.md) for writing new parts of +this spec; as of 2023 it is quite preliminary. You should feel free to +edit it! + ### Managing links We're in the early stages of this spec organization, but we should |