Welcome Book
Welcome to the Vector institute Bookstack Wiki!

Welcome to the Vector Bookstack!
Welcome to the Vector Institute Bookstack Wiki! 
 The Vector Bookstack is a repository built and maintained by the AI Engineering team to share knowledge and documentation both internally and externally! 
 See Contributing for guidelines on the Wiki structure before contributing documentation. 
 
If a shelf appears empty, you may not have permission to view any of the books within it. Log In with your Vector Institute account to access private documentation.

Contributing
Guidelines for contributing documentation. 
 For tips on editing such as custom callouts see Editing Tips . 
 Bookstack Basics: 
 
 Documentation in Bookstack is organized into Books . 
 Each Book contains Pages which contain documentation. 
 Pages within a book can be grouped into Chapters . 
 Books which are related can be grouped into Shelves 
 Books can be placed on multiple shelves 
 
 Vector Bookstack Structure: 
 Adhere to the following structure when contributing documentation: 
 
 Shelf - Team 
 Book - Project 
 Chapter - Subproject or Topic Category 
 Page - Specific subject 
 
 For example: 
 Shelf → Book → Chapter → Page : AI Infra Team → Vec Inf Project → Getting Started → Slurm Basics 
 Additional Organizational Tips: 
 
 If a project is shared across multiple teams, then the book for that project can be placed on both of the shelves for each team. 
 Books are private by default.
 
 Books should only be made public if they are intended to be shared with those who are not Vector proffessional staff and do not contain sensitive information. 
 If a book is made public, all the pages and chapters within that book are also made public. You can override this by explicitly editing the permissions of a page to make it private again. 
 Alternatively you can leave a book as private, and set specific pages within the book to be public 
 
 
 Team Shelves should be made public.
 
 Making a shelf public does not make the books within that shelf public.

Editing Tips
This page outlines some tips and guidelines to use when editing pages. 
 Choosing an Editor 
 The default editor for this Bookstack wiki has been set to Markdown. If you prefer a more traditional WYSIWYG editor (What You See Is What You Get) similar to microsoft word then at then when editing a page select the "Editing Page" or "Draft Saved ..." button at the top center of the screen and select "Switch to WYSIWYG Editor". 
 Callouts: 
 Althoug similar, Bookstack does not use Github Flavoured Markdown (GFM) which might be what most users are used to. The admins of this bookstack have added custom callouts that match the look and style of GFM callouts. 
 <div class="callout note"> Github Style Note Callout</div>
<div class="callout tip"> Github Style Tip Callout</div>
<div class="callout important"> Github Style Important Callout</div>
<div class="callout warn"> Github Style Warning Callout</div>
<div class="callout caution"> Github Style Caution Callout</div>
 
 Github Style Note Callout 
 Github Style Tip Callout 
 Github Style Important Callout 
 Github Style Warning Callout 
 Github Style Caution Callout 
 If these stop working, contact a Wiki administrator and ask them to look at the "Custom HTML Header" for the bookstack. You can also revert to the default callout styles provided by bookstack. 
 <div class="callout info">An info message</div>
<div class="callout success">A success message</div>
<div class="callout warning">A warning message</div>
<div class="callout danger">A danger message</div>
 
 An info message 
 A success message 
 A warning message 
 A danger message 
 Callouts with Code: 
 You can also include code blocks in callouts 
 <div class="callout important"> <!-- Insert a blank line after -->

Important note with some code. 

```python
for i in range(2):
 print(hello)
```
</div>
 
 
 Important note with some code. 
 for i in range(2):
 print(hello)
 
 
 
 Tip on Whitespace 
 If you don't include a blank line after the <div> tag, the text content does not register as a new paragraph. This leads to a weird issue where there is no whitespace between the text content and the codeblock beneath the text content. Eg. 
 <div class="callout important"> <!--No blank line after-->
Important note with some code. 

```python
for i in range(2):
 print(hello)
```
</div>
 
 
Important note with some code.
 for i in range(2):
 print(hello)
 
 
 
 Collapsible Content Blocks 
 It is possible in Bookmark create collapsible content blocks using the html <details> marker. This is useful in reducing the visual length of pages that contain large amounts of documentation. Regular markdown formatting seems to work within collapsible content blocks. Ex. 
 <details>
<summary>Content block title visible when collapsed. Click to expand.</summary>

### A Header

You can also include code blocks and syntax highlighting works

'''python
for i in range(4):
 print("sweet it works!")
'''
</details>
 
 
 Content block title visible when collapsed. Click to expand. 
 A Header 
 You can also include code blocks and syntax highlighting works 
 for i in range(4):
 print("sweet it works!")