bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Started user docs

Browse source
This commit is contained in:
Dan Brown 2016-08-07 05:02:59 -04:00
commit 5aab69d655
4 changed files with 40 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
resources/docs/user/.content-overview.md.swp Normal file
View file

Binary file not shown.

10
resources/docs/user/content-overview.md Normal file
View file

@ -0,0 +1,10 @@
# Content Overview
The principles of storing information within BookStack is based of the ideas of a normal stack of books. Just like normal books, BookStack books can contain chapters and pages. You start off by creating a book which acts as the highest level of categorisation. Ideally you'd have separate books for separate topics. Within a book you can directly create pages or you can first create chapters. Chapters provide an additional level of page grouping to keep pages organised but are optional. All the information you write is held within pages. Although books and chapters do not hold information they can be given a short description to assist with searching and visibility.
### Starting Out
When you start out with your new BookStack instance you can organise things in two ways; You can plan out your book/chapter/page structure or you can let things grow naturally over time. If you know or already have the content which will be going into BookStack then it's probably best to plan early otherwise, if you're starting from scratch, you'll want to let everything find it's own place.
If you decide to grow naturally then you'll likely start with a book for each major category and add pages directly into those books. As you start getting a lot of pages in each book you'll start to use chapters to group those pages. Once a chapter gets too large you may find it better to split it out into it's own book. Within BookStack you can easily move chapters and pages between books and chapters so you shouldn't worry about having to move things around in the future.