feat: scaffold howtos project

Collection of usage guides and cheatsheets. Includes project docs,
topic template, and directory structure.
This commit is contained in:
user
2026-02-21 19:18:48 +01:00
commit c6b4a88736
10 changed files with 233 additions and 0 deletions

29
docs/USAGE.md Normal file
View File

@@ -0,0 +1,29 @@
# Usage
## Browsing Topics
Each topic is a standalone Markdown file in `topics/`:
```bash
# List available topics
ls topics/
# Read a topic in terminal
cat topics/git.md # plain
bat topics/git.md # syntax highlighted
glow topics/git.md # rendered markdown
```
## Adding a New Topic
```bash
cp docs/TEMPLATE.md topics/<name>.md
```
Edit the file following the template structure. Keep it under 200 lines.
## Naming Conventions
- Lowercase, hyphenated: `docker-compose.md`, `git-rebase.md`
- One topic per file
- Use the tool/subject name as the filename