diff options
author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2023-11-07 16:57:07 +0000 |
---|---|---|
committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2023-11-07 17:22:27 +0000 |
commit | 3951488cc33e96ef205835d8e9d3a13cfcda54ec (patch) | |
tree | 3897d73207ea211431be394d7bec9f502f95c231 /spec/README.md | |
parent | f35cafc46f71d223c9f4f90363b33ef0fc05b151 (diff) | |
download | torspec-3951488cc33e96ef205835d8e9d3a13cfcda54ec.tar.gz torspec-3951488cc33e96ef205835d8e9d3a13cfcda54ec.zip |
Move Managing Links subsection into style guide
Diffstat (limited to 'spec/README.md')
-rw-r--r-- | spec/README.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/spec/README.md b/spec/README.md index c20a0fc..0ed46e0 100644 --- a/spec/README.md +++ b/spec/README.md @@ -61,33 +61,6 @@ 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 -still be thinking about long term maintainability. - -Please think about how to keep links working in the long term. -If you are going to add a link to a file, make sure that the file's -name is reasonable. Before you rename a file, consider adding -a redirect from the file's old name. (See the mdbook documentation -for more information about how.) - -If you want to link to a specific section within a file, -make sure that the section has a defined anchor that makes sense. -The syntax to define [heading ids] in mdbook looks like this: - -`## Heading with a long title that you want shorter name for { #shortname }` - -If you need to change a heading, make sure that you keep its -`id` the same as it was before, so that links will still work. - -Finally, when you're looking for specific sections (e.g., to fix -references that say "See section 5.2.3") you can look for the HTML -anchors that our conversion process added. For example, -if you want to find `dir-spec.txt` section 2.1.3, look for -the anchor that says `<a id="dir-spec.txt-2.1.3"></a>`. - ______________________________________________________________________ [git repository]: https://gitlab.torproject.org/tpo/core/torspec/ |