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

doc: update README 

Clarify that doc is the go-forward folder.
This commit is contained in:
Dan Bungert 2023-06-12 14:03:50 -06:00
parent 9bbf1ac058
commit 1e68336595
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/README.md
View File

@ -1,8 +1,11 @@
# Documentation
This temporary folder (`../doc/`) is subject to change and only exists to help
migrate the official documentation for this project to readthedocs.com.
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.
The `../documentation/` folder is the working location for our docs. Any changes
you would like to add to the documentation should be made from this directory,
and not from `../doc/`.
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`.