docs : Update documentation terminology and restructure to LLD format (#64)#67
Merged
basheerFZ merged 4 commits intoMay 13, 2026
Merged
Conversation
…-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>
…ent and migration roadmaps
- 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>
Contributor
Author
|
@basheerFZ please review this pr , Thanks |
basheerFZ
approved these changes
May 13, 2026
Contributor
basheerFZ
left a comment
There was a problem hiding this comment.
In this PR we could see LLD updated , renaming of timpani cases
15 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 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:
Phase → Step:
2. Document Structure Migration: HLD → LLD (Commit: b30c574)
Directory Restructure:
doc/architecture/HLD/→doc/architecture/LLD/# HLD:→# LLD:Component Documentation:
3. Cross-Reference Updates (Commit: 1374343)
Navigation Links:
doc/README.md: All HLD references → LLDdoc/architecture/timpani_architecture.md: 4 references updateddoc/docs/structure.md: Repository structure and links updatedPath Updates:
architecture/HLD/→architecture/LLD/4. File Naming
grpc_architecture.md→timpani_rust_grpc_architecture.mdfor consistencyFiles Changed Summary:
Total: 52 files modified across 4 commits
🔗 Related Issue
Closes #64
🧪 Test Method
Terminology Verification
Structure Verification
doc/architecture/LLD/timpani-o/andtimpani-n/presentPath Reference Verification
Rendering Verification
📸 Screenshots
N/A - Documentation changes only
✅ Checklist
Path Changes:
/HLD/paths have been updated to/LLD/Mitigation:
📊 Impact
Before:
After:
🔍 Review Focus Areas