doc: update README
Clarify that doc is the go-forward folder.
This commit is contained in:
parent
9bbf1ac058
commit
1e68336595
|
@ -1,8 +1,11 @@
|
||||||
# Documentation
|
# Documentation
|
||||||
|
|
||||||
This temporary folder (`../doc/`) is subject to change and only exists to help
|
This `doc` folder is the future location of documentation for Subiquity. This
|
||||||
migrate the official documentation for this project to readthedocs.com.
|
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
|
The `../documentation` folder is the existing location for this sort of
|
||||||
you would like to add to the documentation should be made from this directory,
|
documentation. As the RTD version is not yet ready, documentation changes
|
||||||
and not from `../doc/`.
|
should be made to `../documentation` until this README is updated to say
|
||||||
|
otherwise. As such, please make any desired documentation changes to
|
||||||
|
`../documentation`.
|
||||||
|
|
Loading…
Reference in New Issue