From 1e6833659535776d2fa155dde4790b6e36d7921e Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Mon, 12 Jun 2023 14:03:50 -0600 Subject: [PATCH] doc: update README Clarify that doc is the go-forward folder. --- doc/README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/README.md b/doc/README.md index 57bf8fac..5e3ad891 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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`.