feat: scaffold howtos project
Collection of usage guides and cheatsheets. Includes project docs, topic template, and directory structure.
This commit is contained in:
26
docs/TEMPLATE.md
Normal file
26
docs/TEMPLATE.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Topic Name
|
||||
|
||||
> One-line description of what this tool/subject is.
|
||||
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
# description
|
||||
command --flag argument
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Practical example with context
|
||||
command --option value
|
||||
```
|
||||
|
||||
## Gotchas
|
||||
|
||||
- Known pitfall or surprising behavior
|
||||
|
||||
## See Also
|
||||
|
||||
- `related-topic` — brief note
|
||||
- [External reference](https://example.com)
|
||||
Reference in New Issue
Block a user