StealthOS/subiquity
StealthOS
/
subiquity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: update readme for removal of `documentation`

This commit is contained in:
Dan Bungert 2023-11-02 18:31:47 +02:00
parent 44fcdbcb31
commit 929a3df281
1 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/README.md
View File

@ -1,19 +1,14 @@
# Documentation
This `doc` folder is the future location of documentation for Subiquity. This
will be used to migrate the official documentation to readthedocs, and later
will be the home of that documentation.
This `doc` folder is the location of documentation for Subiquity.
The `../documentation` folder is the existing location for this sort of
documentation. As the RTD version is not yet ready, documentation changes
should be made to `../documentation` until this README is updated to say
otherwise. As such, please make any desired documentation changes to
`../documentation`.
In the not distant past, there was also a `../documentation` folder, but that
is now an obsolete copy of what was on Discourse.
# Local preview
To build this documentation, you can run `make install` from this folder to
create the virtual environment.
create the virtual environment.
Then run the `make run` command, which will build a html version of the docs,
and serve the docs in the virtual environment. This is very convenient if you