Documentation changes for Milestone-1 from Development 0.5 #72
Merged
Conversation
- Introduced a new document `grpc_architecture.md` detailing the gRPC integration for TIMPANI, including architectural changes, service specifications, and performance comparisons. - Updated `timpani_architecture.md` to reflect the current system architecture and migration status, including detailed component responsibilities and communication flow. - Enhanced the repository structure in `structure.md` to clarify the organization of documentation and Rust components. - Added images for visual representation of the architecture. Co-authored-by: Copilot <copilot@github.com>
docs : Complete HLD/LLD and Architecture Documentation for TIMPANI Rust Migration #62
…-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>
docs : Update documentation terminology and restructure to LLD format (#64)
…entation files Co-authored-by: Copilot <copilot@github.com>
docs: Add documentation metadata and revision history (#65)
- Introduced a comprehensive requirements specification document for the timpani system, detailing functional and non-functional requirements, including real-time scheduling, task management, communication, and fault tolerance. - Created a feature specification document outlining the system architecture, component breakdown, and feature descriptions for timpani-o (Global Orchestrator), timpani-n (Node Executor), and sample applications. - Included diagrams for system block architecture and a feature breakdown table to enhance clarity and understanding of the system components and their interactions. Co-authored-by: Copilot <copilot@github.com>
…ecture diagrams Co-authored-by: Copilot <copilot@github.com>
…rity Co-authored-by: Copilot <copilot@github.com>
…ope representation Co-authored-by: Copilot <copilot@github.com>
…multiple documents Co-authored-by: Copilot <copilot@github.com>
docs :Requirements Traceability and Feature Hierarchy #66
Co-authored-by: Copilot <copilot@github.com>
docs: Add scope legends to timpani system block diagrams
basheerFZ
added
documentation
basheerFZ
added this to
timpani Development, timpani Release and timpani feature requirements
basheerFZ
requested review from
jayakrishnan04b
and removed request for
daeyoung-jeong-lge and
jayakrishnan04b
github-project-automation
Bot
moved this from In Progress
to Done
in timpani feature requirements
github-project-automation
Bot
moved this from In progress
to Done
in timpani Development
Contributor
Author
|
All the documents shall be maintained till HQ will check and update the documents and then it will be moved to Approved state |
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
3 participants
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.
Documentation changes for Milestone-1 from Development 0.5