aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-23 17:04:44 +0000
committerFuwn <[email protected]>2021-05-23 17:04:44 +0000
commitfa75ca186778051edff4046f369b21c12bf3e13f (patch)
tree0fa654be0514c1977d84b15624265b8a35929181
parentdocs(global): spelling corrections, global docs (diff)
downloadwhirl-fa75ca186778051edff4046f369b21c12bf3e13f.tar.xz
whirl-fa75ca186778051edff4046f369b21c12bf3e13f.zip
docs(readme): expand documentation section
-rw-r--r--README.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index ef4c1e1..ba60e80 100644
--- a/README.rst
+++ b/README.rst
@@ -58,7 +58,12 @@ blog).
Documentation
-------------
-https://whirlsplash.org/docs/
+Documentation about the entire Whirlsplash ecosystem can be found
+`here <https://whirlsplash.org/docs/>`_.
+
+If you are looking for explicit documentation of only Whirl's source code, you
+must generate them yourself be cloning the repository and running the Cargo
+subcommand: `cargo +nightly doc --open --document-private-items --no-deps`.
Known Issues
------------