File tree Expand file tree Collapse file tree 1 file changed +5
-0
lines changed Expand file tree Collapse file tree 1 file changed +5
-0
lines changed Original file line number Diff line number Diff line change @@ -106,6 +106,9 @@ a GitHub Action runs [Mike],
106106which commits a new version of the docs to the ` gh-pages ` branch
107107so that it is deployed to [ GitHub Pages] .
108108
109+ When editing our documentation, please use [ semantic linefeeds] [ ] .
110+ (For a formal definition which we only loosely adhere to, see [ sembr.org] [ sembr ] .)
111+
109112To build the docs locally, you will need the "docs" dependency-group installed
110113(if you have already installed the "dev" group, you can skip this):
111114
@@ -126,4 +129,6 @@ mkdocs serve
126129[ Mike ] : https://github.com/jimporter/mike
127130[ MkDocs ] : https://www.mkdocs.org/
128131[ keepachangelog ] : https://keepachangelog.com/
132+ [ semantic linefeeds ] : https://rhodesmill.org/brandon/2012/one-sentence-per-line/
133+ [ sembr ] : https://sembr.org/
129134[ semver ] : https://semver.org/
You can’t perform that action at this time.
0 commit comments