]> BookStack Code Mirror - website/commitdiff
Started user docs
authorDan Brown <redacted>
Sun, 7 Aug 2016 09:02:59 +0000 (05:02 -0400)
committerDan Brown <redacted>
Sun, 7 Aug 2016 09:02:59 +0000 (05:02 -0400)
resources/docs/user/.content-overview.md.swp [new file with mode: 0644]
resources/docs/user/content-overview.md [new file with mode: 0644]
resources/views/docs/user-sidebar.blade.php [new file with mode: 0644]
resources/views/docs/user.blade.php [new file with mode: 0644]

diff --git a/resources/docs/user/.content-overview.md.swp b/resources/docs/user/.content-overview.md.swp
new file mode 100644 (file)
index 0000000..cc19d52
Binary files /dev/null and b/resources/docs/user/.content-overview.md.swp differ
diff --git a/resources/docs/user/content-overview.md b/resources/docs/user/content-overview.md
new file mode 100644 (file)
index 0000000..e15fe58
--- /dev/null
@@ -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.
+
diff --git a/resources/views/docs/user-sidebar.blade.php b/resources/views/docs/user-sidebar.blade.php
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/resources/views/docs/user.blade.php b/resources/views/docs/user.blade.php
new file mode 100644 (file)
index 0000000..0796536
--- /dev/null
@@ -0,0 +1,30 @@
+@extends('base')
+
+@section('header')
+       <div class="row">
+               <div class="col-md-12">
+                       <h2 class="thin-margin">User Documentation</h2>
+               </div>
+       </div>
+@stop
+
+@section('content')
+
+<div class="container">
+       
+       <div class="col-sm-2 sidebar">
+               @include('docs/user-sidebar')
+       </div>
+
+       <div class="col-sm-8 col-sm-offset-1 docs-content">
+               <a class="float right edit-link" target="_blank"
+                  href="https://github.com/ssddanbrown/BookStack-Site/blob/master/resources/docs/{{ $type }}/{{ $page }}.md">
+                       <span class="icon small">{!! icon('edit') !!}</span>
+                       Edit page
+               </a>
+               {!! $html !!}
+       </div>
+
+</div>
+
+@stop