Files
docs/foundations/index.md
Nicole Rappe e73bb0376f
All checks were successful
GitOps Automatic Documentation Deployment / Sync Docs to https://kb.bunny-lab.io (push) Successful in 4s
GitOps Automatic Documentation Deployment / Sync Docs to https://docs.bunny-lab.io (push) Successful in 6s
Documentation Restructure
2026-01-27 05:25:22 -07:00

778 B

Foundations

Purpose

Defines the baseline documentation standards, shared references, and structural conventions used everywhere else in this knowledgebase.

Includes

  • Documentation styling contract
  • Inventory and naming conventions
  • Shared templates and glossary references

New Document Template

# <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
```