summaryrefslogtreecommitdiffstats
path: root/docs/structure.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-03-05 15:14:17 +0100
committerSamy Pessé <samypesse@gmail.com>2016-03-05 15:14:17 +0100
commit29533908c2b28f7d0f596bd25c07e06563f027ae (patch)
tree8e68fdb754d720af9c20afc403759c27835dd738 /docs/structure.md
parent603622e3379e1381b7acedf5174ceba656b15285 (diff)
parent74a1e9dee23ab44c2242c69f3ee5091454af42a8 (diff)
downloadgitbook-29533908c2b28f7d0f596bd25c07e06563f027ae.zip
gitbook-29533908c2b28f7d0f596bd25c07e06563f027ae.tar.gz
gitbook-29533908c2b28f7d0f596bd25c07e06563f027ae.tar.bz2
Merge pull request #1168 from GitbookIO/enhancement/doc
v3 doc review
Diffstat (limited to 'docs/structure.md')
-rw-r--r--docs/structure.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/structure.md b/docs/structure.md
index a811bd9..907f3e0 100644
--- a/docs/structure.md
+++ b/docs/structure.md
@@ -1,6 +1,6 @@
# Directory structure
-GitBook uses a very simple and obvious directory structure:
+GitBook uses a simple directory structure:
```
.
@@ -26,7 +26,7 @@ An overview of what each of these does:
### Static files and Images
-A static file is a file that is not listed in the `SUMMARY.md`. All static files, not [ignored](#ignore), are copied to the output.
+A static file is a file that is not listed in the `SUMMARY.md`. All static files, unless [ignored](#ignore), are copied to the output.
### Ignoring files & folders {#ignore}
@@ -43,9 +43,9 @@ test.md
bin/*
```
-### Project documentation / Sub-directory {#subdirectory}
+### Project integration with subdirectory {#subdirectory}
-For software project, it sometimes better to use a diretcory (like `docs/`) to store the project's documentation. You can use the [`root` option](config.md) to indicate to GitBook in which folder the book is stored:
+For software projects, you can use a subdirectory (like `docs/`) to store the book for the project's documentation. You can configure the [`root` option](config.md) to indicate the folder where GitBook can find the book's files:
```
.