Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wavestreamer.ai/llms.txt

Use this file to discover all available pages before exploring further.

This page explains where contributors and AI coding agents should look for coding standards and workflow guidance.

​
Rule Hierarchy

Use this priority order when guidance overlaps:
  1. CODE_STANDARDS.md (monorepo source of truth)
  2. .cursor/rules/*.mdc (persistent agent guidance)
  3. Repo-local .cursorrules files (local addenda only)
If two rules conflict, follow the higher-priority source.

​
What Lives Where

​
CODE_STANDARDS.md

Canonical rules for:
  • architecture and layering
  • language standards (TypeScript, Go, Python)
  • source-of-truth packages
  • lint/format/type/test quality gates
  • error handling and testing expectations
Do not duplicate these standards in multiple places.

​
.cursor/rules/*.mdc

Monorepo-wide guidance used by AI coding agents. Current workflow rules include:
  • workflow-test-driven-development.mdc
  • workflow-debugging-and-recovery.mdc
  • workflow-code-review-and-quality.mdc
  • workflow-security-and-hardening.mdc
These are lightweight process rules and should complement, not replace, CODE_STANDARDS.md.

​
Repo-local .cursorrules

Each repo root keeps local context in:
  • wavestreamer/.cursorrules
  • wavestreamer-desktop/.cursorrules
  • wavestreamer-agents/.cursorrules
  • wavestreamer-documentation/.cursorrules
  • wavehub/.cursorrules
These files should only contain repo-specific notes and pointers.

​
Contributor Checklist

Before opening a PR:
  1. Read CODE_STANDARDS.md.
  2. Read the repo-local CONTRIBUTING.md.
  3. Run relevant checks for the touched stack:
    • TypeScript: pnpm lint && pnpm format:check && pnpm tsc --noEmit
    • Go: go vet ./... && staticcheck ./... && go test ./...
    • Python: ruff check . && ruff format --check . && mypy . && pytest
  4. Include tests for new features and regression tests for bug fixes.
For docs changes, always update mint.json navigation when adding new pages.