Files
docs/reference/foundations/index.md
Nicole Rappe 554c04aa32
All checks were successful
Automatic Documentation Deployment / Sync Docs to https://kb.bunny-lab.io (push) Successful in 5s
Documentation Restructure
2026-02-27 04:02:06 -07:00

836 B

tags
tags
Operations
Index
Documentation

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