AdminPages - BevvyTech/BrewskiDocs GitHub Wiki

Admin UI Page Documentation Guidance

Whenever you modify code under /Admin, capture the corresponding page behaviour in this directory.

  • Add or update a Markdown file per Admin route (e.g. orders.md, clients.md).
    • Summaries should explain the page’s purpose, primary data flows, and key UI actions.
    • Avoid repeating global navigation items; focus on what the page enables the user to do.
  • Keep the tone factual and pragmaticβ€”no marketing copy, just the essentials future contributors need.
  • When introducing a brand-new page, seed the doc with the route path, critical components, and any feature flags or prerequisites tied to it.
  • Maintain a top-level navigation tree in this directory: update the list of documented pages and their routes whenever a page entry is added, removed, or renamed so contributors can see coverage at a glance.

Page Index

This directory is ingested into the RAG corpus, so structure headings consistently and prefer short paragraphs or bullet lists.

Miscellaneous Assets

  • public/health.json β€” static health ping consumed by the health dashboard at https://health.brewskiapp.com/.
⚠️ **GitHub.com Fallback** ⚠️