Skip to content

Commit 6713819

Browse files
author
Devyn Stott
committed
docs(): Move to dedicated docs folder
Adding the docs inline to the source code made it too messy. So I've moved them to their own directory and adjusted a few of the comments to reflect this change.
1 parent 5f3e107 commit 6713819

File tree

8 files changed

+8
-9
lines changed

8 files changed

+8
-9
lines changed

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Starter documentation
2+
3+
The home page for the documentation is found in index.md. To contribute, edit these files.
4+
5+
To add, remove, or reorder pages, add them to the `mkdocs.yml` file in the root directory.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
site_name: Python-Starter
22
repo_url: https://github.com/SyntaxRules/python-starter/
33
theme: readthedocs
4-
docs_dir: 'starter'
54
pages:
65
- 'Overview': 'index.md'
76
- 'User Guide':
8-
- 'Quick Start': 'docs/quick-start.md'
9-
- 'Installation Instructions': 'docs/installation-instructions.md'
10-
- 'License': 'docs/license.md'
7+
- 'Quick Start': 'quick-start.md'
8+
- 'Installation Instructions': 'installation-instructions.md'
9+
- 'License': 'license.md'

starter/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)