Skip to content

[TASK] [DOCS]Terminology and Document Structure Updates #64

@LGSI-KarumuriHari

Description

@LGSI-KarumuriHari

📝 Task Description

Update documentation terminology for consistency and restructure HLD documents to LLD (Low-Level Design) format as per review feedback.

Changes Required:

  1. Replace all instances of "TIMPANI" (uppercase) with "timpani" (lowercase) across all documentation
  2. Replace "phases" terminology with "steps" throughout documentation
  3. Restructure HLD documents to LLD format (move contents from doc/architecture/HLD/ to doc/architecture/LLD/)
  4. Update all cross-references and links to reflect new LLD structure

📋 Checklist

  • Find and replace "TIMPANI" → "timpani" in all .md files
  • Find and replace "Phase(s)" → "Step(s)" in all documentation
  • Rename doc/architecture/HLD/ directory to doc/architecture/LLD/
  • Update all HLD references to LLD in documentation
  • Update README.md navigation links (HLD → LLD)
  • Update timpani_architecture.md references
  • Update all component document headers (HLD → LLD)
  • Verify all internal links still work after changes
  • Update mermaid diagrams if they contain "TIMPANI" or "Phase"

🔗 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

  • Run grep to confirm no "TIMPANI" remains: grep -r "TIMPANI" doc/
  • Run grep to confirm no "HLD" path references remain: grep -r "HLD/" doc/
  • Verify all markdown files render correctly in GitHub preview
  • Test all internal documentation links
  • Verify mermaid diagrams render correctly
  • Check that all cross-references between documents still work

⚠️ Breaking Changes

  • All existing links to /HLD/ paths will need updating
  • Any external references to these documents may break

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

Status

Done

Status

Done

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions