📝 Task Description
Update documentation terminology for consistency and restructure HLD documents to LLD (Low-Level Design) format as per review feedback.
Changes Required:
- Replace all instances of "TIMPANI" (uppercase) with "timpani" (lowercase) across all documentation
- Replace "phases" terminology with "steps" throughout documentation
- Restructure HLD documents to LLD format (move contents from
doc/architecture/HLD/ to doc/architecture/LLD/)
- Update all cross-references and links to reflect new LLD structure
📋 Checklist
🔗 Related Requirement
Relates to #28
📐 Implementation Guidelines
Scope of changes:
- All files in
doc/ directory and subdirectories
- Focus areas:
doc/README.md
doc/architecture/timpani_architecture.md
doc/architecture/grpc_architecture.md
- All files in
doc/architecture/HLD/timpani-o/ (10 files + README)
- All files in
doc/architecture/HLD/timpani-n/ (10 files + README)
doc/docs/structure.md
doc/docs/api.md
Terminology replacements:
- "TIMPANI" → "timpani" (preserve case in acronyms if needed)
- "Phase 1/2/3/etc." → "Step 1/2/3/etc."
- "HLD" → "LLD" (Low-Level Design)
Directory restructure:
mv doc/architecture/HLD doc/architecture/LLD
🧪 Testing Method
⚠️ Breaking Changes
- All existing links to
/HLD/ paths will need updating
- Any external references to these documents may break
📝 Task Description
Update documentation terminology for consistency and restructure HLD documents to LLD (Low-Level Design) format as per review feedback.
Changes Required:
doc/architecture/HLD/todoc/architecture/LLD/)📋 Checklist
.mdfilesdoc/architecture/HLD/directory todoc/architecture/LLD/🔗 Related Requirement
Relates to #28
📐 Implementation Guidelines
Scope of changes:
doc/directory and subdirectoriesdoc/README.mddoc/architecture/timpani_architecture.mddoc/architecture/grpc_architecture.mddoc/architecture/HLD/timpani-o/(10 files + README)doc/architecture/HLD/timpani-n/(10 files + README)doc/docs/structure.mddoc/docs/api.mdTerminology replacements:
Directory restructure:
🧪 Testing Method
grep -r "TIMPANI" doc/grep -r "HLD/" doc//HLD/paths will need updating