Restructured Documentation
Automatic Documentation Deployment / Sync Docs to https://kb.bunny-lab.io (push) Successful in 8s

This commit is contained in:
2026-09-05 14:08:43 -06:00
parent c4bd235eba
commit 289769a601
281 changed files with 5403 additions and 3563 deletions
+11 -37
View File
@@ -1,47 +1,21 @@
---
tags:
- Operations
- Index
- Foundations
- Reference
- Documentation
---
# Foundations
## Purpose
Defines the baseline documentation standards, shared references, and structural conventions used everywhere else in this knowledgebase.
Maintain the knowledgebase using the authoritative styling contract, document roles, and source-relative links.
## Includes
- Documentation styling contract
- Inventory and naming conventions
- Shared templates and glossary references
- Apply the authoritative Markdown and document-type contract.
- Choose the content role, subject, and related guides for a new page.
- Use the canonical template for the intended page type.
## New Document Template
````markdown
# <Document Title>
## Purpose
<one paragraph describing why this exists>
!!! info "Assumptions"
- <OS / platform / privilege assumptions>
- <required tools or prerequisites>
## Scope
- <what is covered>
- <what is explicitly out of scope>
## Procedure
```sh
# Commands go here (grouped and annotated)
```
## Validation
- <command + expected result>
## Troubleshooting
### Symptoms
- <what you see>
### Resolution
```sh
# Fix steps
```
````
## Find the Right Document
- [Documentation Styling](<Documentation Styling.md>) — Apply the authoritative Markdown and document-type contract.
- [Documentation Organization](<Documentation Organization.md>) — Choose the content role, subject, and related guides for a new page.
- [Choose a Document Template](<Choose a Document Template.md>) — Use the canonical template for the intended page type.
- [Documentation Path Changes](<Documentation Path Changes.md>) — Map former source paths to their new locations when maintaining external links.