From ad8465dafb6cb5b66417de91403c05e52dc2e249 Mon Sep 17 00:00:00 2001
From: Darren Burns <darrenb900@gmail.com>
Date: Mon, 7 Feb 2022 10:24:50 +0000
Subject: [PATCH] Add info to a README for docs

---
 docs/README.md | 18 ++++++++++++++++++
 docs/index.md  | 14 --------------
 2 files changed, 18 insertions(+), 14 deletions(-)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..d71be6ef6
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,18 @@
+# Documentation Workflow
+
+* Ensure you're inside the virtual environment `poetry shell`
+* Run the live-reload server using `mkdocs serve`
+* Create new pages by adding new Markdown files
+
+## Commands
+
+- `mkdocs serve` - Start the live-reloading docs server.
+- `mkdocs build` - Build the documentation site.
+- `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/index.md b/docs/index.md
index bc96ca692..79d76e1ae 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -9,17 +9,3 @@ Creating a TUI can be challenging. It may be easier to create a GUI or web appli
 Textual seeks to lower the difficulty level of building a TUI by borrowing developments from the web world and to a lesser extent desktop applications. The goal is for it to be as easy to develop a TUI for your project as it would be to add a command line interface.
 
 Textual also offers a number of enhancements over traditional TUI applications by taking advantage of improvements to terminal software and the hardware it runs on. Terminals are a far cry from their roots in ancient hardware and dial-up modems, yet much of the software that runs on them hasn't kept pace.
-
-## Commands
-
-- `mkdocs new [dir-name]` - Create a new project.
-- `mkdocs serve` - Start the live-reloading docs server.
-- `mkdocs build` - Build the documentation site.
-- `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.