Files
howtos/PROJECT.md
user c6b4a88736 feat: scaffold howtos project
Collection of usage guides and cheatsheets. Includes project docs,
topic template, and directory structure.
2026-02-21 19:18:48 +01:00

949 B

Project: howtos

Motivation

Scattered notes, bookmarks, and history | grep are poor substitutes for well-organized reference material. This project centralizes practical knowledge into a consistent, maintainable format.

Goals

  • Provide quick-reference guides for daily tools and workflows
  • Maintain a consistent structure across all topics
  • Keep content concise and actionable — no tutorials, just references
  • Make it easy to add new topics via a template

Architecture

Flat file collection — no build step, no dependencies. Plain Markdown rendered by any viewer (terminal, browser, editor).

topics/<topic>.md     # Individual howto files
docs/TEMPLATE.md      # Template for new topics

Dependencies

None. Plain Markdown files. Optionally viewed with glow, bat, or any Markdown renderer.

Non-Goals

  • Not a tutorial site or blog
  • Not a wiki with cross-linking
  • Not auto-generated from --help output