Skip to content

docs : Update documentation terminology and restructure to LLD format (#64)#67

Merged
basheerFZ merged 4 commits into
eclipse-timpani:development_0.5from
LGSI-KarumuriHari:main
May 13, 2026
Merged

docs : Update documentation terminology and restructure to LLD format (#64)#67
basheerFZ merged 4 commits into
eclipse-timpani:development_0.5from
LGSI-KarumuriHari:main

Conversation

@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor

📝 PR Description

This PR implements comprehensive documentation updates to standardize terminology and restructure design documents from HLD (High-Level Design) to LLD (Low-Level Design) format, as per documentation review feedback.

Changes Implemented:

1. Terminology Standardization (Commits: d0e552e, e4a9f26, 1374343)

TIMPANI → timpani:

  • ✅ Replaced all instances of "TIMPANI" (uppercase) with "timpani" (lowercase) across 24+ documentation files
  • ✅ Standardized naming: "Timpani-O" → "timpani-o", "Timpani-N" → "timpani-n"
  • ✅ Updated 510+ lines across architecture, API, development guides, and README files
  • ✅ Maintained consistency in component naming throughout the project

Phase → Step:

  • ✅ Replaced "phases" with "steps" in development and migration roadmaps
  • ✅ Updated documentation flow references
  • ✅ Standardized terminology across all workflow descriptions

2. Document Structure Migration: HLD → LLD (Commit: b30c574)

Directory Restructure:

  • ✅ Renamed doc/architecture/HLD/doc/architecture/LLD/
  • ✅ Updated 22 component documents (10 timpani-o + 10 timpani-n + 2 READMEs)
  • ✅ Changed all document titles from # HLD:# LLD:
  • ✅ Updated document headers: "High-Level Design" → "Low-Level Design"

Component Documentation:

  • timpani-o: 10 LLD documents (SchedInfo, Fault Client, Node Service, Scheduler, etc.)
  • timpani-n: 10 LLD documents (Initialization, Config, Time Trigger, Task Management, etc.)
  • ✅ Both README.md files updated with new terminology

3. Cross-Reference Updates (Commit: 1374343)

Navigation Links:

  • ✅ Updated doc/README.md: All HLD references → LLD
  • ✅ Updated doc/architecture/timpani_architecture.md: 4 references updated
  • ✅ Updated doc/docs/structure.md: Repository structure and links updated
  • ✅ Updated documentation flow diagrams to reflect LLD structure

Path Updates:

  • ✅ All links changed from architecture/HLD/architecture/LLD/
  • ✅ Component README links verified and updated
  • ✅ Documentation flow updated: Architecture → LLD → Implementation

4. File Naming

  • ✅ Renamed grpc_architecture.mdtimpani_rust_grpc_architecture.md for consistency

Files Changed Summary:

Total: 52 files modified across 4 commits

  • Terminology updates: 26 files (510 lines changed)
  • Phase → Step: 5 files (41 deletions)
  • HLD → LLD: 22 files (166 changes)
  • Navigation updates: 4 files (66 changes)

🔗 Related Issue

Closes #64

🧪 Test Method

Terminology Verification

  • ✅ Confirmed no "TIMPANI" (uppercase) remains:
    grep -r "TIMPANI" doc/ # No results
  • ✅ Verified "Phase" replaced with "Step" where applicable
  • ✅ All component names use lowercase format (timpani-o, timpani-n)

Structure Verification

  • ✅ Confirmed LLD directory exists: doc/architecture/LLD/
  • ✅ Verified subdirectories: timpani-o/ and timpani-n/ present
  • ✅ All 20 component files + 2 READMEs present and accessible

Path Reference Verification

  • ✅ No HLD path references remain:
    grep -r "architecture/HLD" --include="*.md" doc/ # No results
  • ✅ All internal links tested and working
  • ✅ Component README links verified
  • ✅ Total LLD references: 64 instances across documentation

Rendering Verification

  • ✅ All markdown files render correctly in GitHub
  • ✅ Mermaid diagrams display correctly with updated terminology
  • ✅ Cross-references between documents verified
  • ✅ Table of contents links functional in all README files

📸 Screenshots

N/A - Documentation changes only

✅ Checklist

  • Code conventions are followed (markdown formatting, SPDX headers preserved)
  • Tests are added/modified (N/A for documentation)
  • Documentation is updated (this PR IS the documentation update)
  • All terminology standardized per review feedback
  • Directory structure reflects LLD classification
  • All internal links verified and functional
  • No broken references remain

⚠️ Breaking Changes

Path Changes:

  • All links to /HLD/ paths have been updated to /LLD/
  • External references to these documents will need updating if they exist
  • Bookmarks to old paths will need to be updated

Mitigation:

  • All internal documentation links have been updated
  • Clear commit messages document the changes
  • README files provide navigation to new structure

📊 Impact

Before:

  • Mixed terminology (TIMPANI/timpani, Phase/Step)
  • HLD classification (incorrect for detailed design docs)
  • Inconsistent component naming

After:

  • ✅ Consistent lowercase terminology throughout
  • ✅ Correct LLD classification for component-level documents
  • ✅ Standardized naming conventions
  • ✅ Improved navigation with updated links
  • ✅ Better alignment with documentation standards

🔍 Review Focus Areas

  1. Terminology Consistency: Verify all instances of TIMPANI replaced correctly
  2. Path Accuracy: Check that all LLD path references are correct
  3. Link Integrity: Test internal documentation links
  4. Document Structure: Confirm LLD classification is appropriate
  5. Completeness: Ensure all 64 task checklist items addressed

LGSI-KarumuriHari and others added 4 commits May 13, 2026 14:41
…-o" and "timpani-n"

- Updated all instances of "Timpani-O" to "timpani-o" and "Timpani-N" to "timpani-n" across various documentation files, including architecture, API, development guides, and README files.
- Ensured consistency in naming throughout the project documentation to reflect the new lowercase naming convention.
- Adjusted references in communication protocols, error handling, and global scheduler documentation to align with the updated naming.

Co-authored-by: Copilot <copilot@github.com>
- Introduced 10 LLD documents detailing the migration process, including component overviews, comparisons between C++ and Rust implementations, and design decisions.
- Added comprehensive error handling documentation outlining structured error types, propagation strategies, and fault recovery mechanisms.
- Included a README.md summarizing the project, migration themes, verification status, and terminology for better understanding and navigation of the documentation.
…ogy and structure

Co-authored-by: Copilot <copilot@github.com>
@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor Author

@basheerFZ please review this pr , Thanks

Copy link
Copy Markdown
Contributor

@basheerFZ basheerFZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this PR we could see LLD updated , renaming of timpani cases

@basheerFZ basheerFZ merged commit 10206f2 into eclipse-timpani:development_0.5 May 13, 2026
6 checks passed
@basheerFZ basheerFZ linked an issue May 13, 2026 that may be closed by this pull request
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TASK] [DOCS]Terminology and Document Structure Updates

2 participants