docs: Add documentation metadata and revision history (#65)#68
Merged
basheerFZ merged 2 commits intoMay 13, 2026
Merged
Conversation
…entation files Co-authored-by: Copilot <copilot@github.com>
Contributor
Author
|
@basheerFZ please review this pr , Thanks |
15 tasks
basheerFZ
requested changes
May 13, 2026
Contributor
basheerFZ
left a comment
There was a problem hiding this comment.
Please update the Author to your name
Document status should be draft 0.1 review can be 0.2 , Approved shld reflect 1.0
Revision history needs to reflect the original date as these documentations are moving from other repositories now to github
please make the changes as per these reviews and update it
Contributor
Author
|
@basheerFZ i have resolved the requested review comments with the new commit please check and merge , Thanks |
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 standardized documentation metadata headers and revision history tracking across all Eclipse timpani documentation files to ensure proper traceability, version control, and attribution.
Changes Implemented:
1. Documentation Metadata Headers Added (27 files)
Added to all documentation files:
Document Information section with:
Revision History table with columns:
2. Configuration ID Assignment
LLD Documents (22 files):
timpani-o-lld-01throughtimpani-o-lld-10timpani-o-lld-index(README)timpani-n-lld-01throughtimpani-n-lld-10timpani-n-lld-index(README)Architecture Documents (2 files):
timpani-arch-system(timpani_architecture.md)timpani-arch-grpc(timpani_rust_grpc_architecture.md)Project Documentation (3 files):
timpani-api-reference(api.md)timpani-doc-structure(structure.md)timpani-doc-index(README.md)3. Version Numbering Convention
Alpha Versioning (0.0a):
4. Contribution Guidelines Update
Added Section 7: Documentation Metadata Standards
Files Modified Summary:
Total: 28 files
🔗 Related Issue
Closes #65
🧪 Test Method
Metadata Header Verification