Files
cinny/docs/handoff/TEMPLATE.md
T
litruv a6ad8651b3
Checks / checks (push) Successful in 2m11s
Trigger cinny-mobile / dispatch (push) Successful in 1s
Apply the auto-fixable lint rules and the formatter, and drop the Vite build artifacts.
2026-11-01 04:23:53 +11:00

68 lines
1.3 KiB
Markdown

# <Feature name> — handoff
> Copy this file to `handoff/features/<feature-name>/HANDOFF.md` and replace all placeholders.
## Summary
<!-- One paragraph: what this feature does and why Paarrot has it. -->
## User-facing behavior
<!-- What users see, where in the UI, and what settings exist. -->
## Architecture
<!-- High-level flow: UI → hooks/services → Matrix/Electron/OS. -->
```
<!-- Optional ASCII or mermaid diagram -->
```
## Key files
| Path | Role |
| -------------- | --------------------- |
| `path/to/file` | <!-- what it does --> |
## Data model
<!-- Matrix state events, account data types, local storage keys. -->
| Key / event | Scope | Shape |
| ----------- | ----- | ----- |
| | | |
## Dependencies
<!-- npm packages, external APIs, OS permissions. -->
## Integration points
<!-- Other features, local API, plugins, IPC channels. -->
## Testing
### Manual
1. <!-- step -->
### Automated
<!-- test files or "none yet" -->
## Known issues & gotchas
<!-- Sharp edges, race conditions, platform differences. -->
## Future work
<!-- Planned improvements or open questions. -->
## Related docs
- <!-- links -->
## Add your extra things here
<!-- Feature-specific notes: rollout flags, server requirements, MSC numbers, etc. -->