Commit graph

9 commits

Author SHA1 Message Date
Julian Pawlowski
b191238df4 docs(agents): add logging and documentation writing guidelines
Extended AGENTS.md with comprehensive patterns learned from period
calculation development and documentation rewrite.

Logging Guidelines:
- Added hierarchical indentation pattern (INDENT_L0-L5)
- Defined log level strategy (INFO=compact/scannable,
  DEBUG=detailed/hierarchical, WARNING=top-level)
- Added configuration context headers for complex calculations
- Documented per-day processing patterns
- Added note about logs as documentation foundation

User Documentation Quality:
- Added principles: clarity over completeness, visual examples,
  use-case driven structure, practical troubleshooting, progressive
  disclosure
- Added validation rules for code-documentation sync

Documentation Writing Strategy (new section):
- Live understanding vs. cold code analysis
- User feedback loop importance
- Log-driven documentation approach
- Concrete examples over abstract descriptions
- Context accumulation in long sessions
- Document the "why", not just the "what"

Impact: Future AI sessions can produce better logs (traceable logic
with visual hierarchy) and better documentation (user-focused with
concrete examples from live development).
2025-11-11 21:20:06 +00:00
Julian Pawlowski
6a77572f4e refactor(docs): update references from copilot-instructions.md to AGENTS.md across documentation 2025-11-10 14:09:40 +00:00
Julian Pawlowski
ab73d02ec1 chore(copilot): Add AGENTS.md 2025-11-10 12:13:53 +00:00
Julian Pawlowski
2e1fb2f061 add symlinks for agents 2025-11-03 17:45:25 +00:00
Julian Pawlowski
5ee780da87 update translations 2025-11-03 09:53:19 +00:00
Julian Pawlowski
4cd93d8a80 bump version 2025-11-02 16:12:01 +00:00
Julian Pawlowski
34616e2c05 bump version 2025-11-02 14:10:23 +00:00
Julian Pawlowski
8cef04c682 update 2025-11-02 13:50:35 +00:00
Julian Pawlowski
fc5e4ca6f4 add AGENTS.md 2025-11-02 11:43:47 +00:00