Skip to content

docs: Add documentation metadata and revision history (#65)#68

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

docs: Add documentation metadata and revision history (#65)#68
basheerFZ merged 2 commits into
eclipse-timpani:development_0.5from
LGSI-KarumuriHari:development_0.5

Conversation

@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor

📝 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:

    • Issuing Author (Eclipse timpani Team)
    • Unique Configuration ID following naming convention
    • Document Status (Published)
    • Last Updated date (2026-05-13)
  • Revision History table with columns:

    • Version (0.0a - alpha release)
    • Date (2026-05-13)
    • Comment (Initial creation)
    • Author (Eclipse timpani Team)
    • Approver (-)

2. Configuration ID Assignment

LLD Documents (22 files):

  • timpani-o: timpani-o-lld-01 through timpani-o-lld-10
  • timpani-o: timpani-o-lld-index (README)
  • timpani-n: timpani-n-lld-01 through timpani-n-lld-10
  • timpani-n: timpani-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):

  • All documents start at version 0.0a to indicate initial alpha/draft status
  • Follows semantic versioning with alpha designation for pre-release documentation
  • Provides clear indication that documents are in initial state

4. Contribution Guidelines Update

Added Section 7: Documentation Metadata Standards

  • Complete metadata header template with examples
  • Configuration ID naming conventions and format rules
  • Document status values (Draft, Review, Approved, Published)
  • Revision history guidelines with versioning rules
  • Alpha versioning convention (0.0a for initial documents)
  • Example revision history entries
  • Files requiring metadata (complete list)
  • Metadata maintenance procedures
  • Verification checklist for documentation changes

Files Modified Summary:

Total: 28 files

  • LLD Documents: 22 files (timpani-o: 11, timpani-n: 11)
  • Architecture: 2 files
  • Project Docs: 3 files
  • Guidelines: 1 file (contribution/guidelines-en.md)

🔗 Related Issue

Closes #65

🧪 Test Method

Metadata Header Verification

  • ✅ Verified all 27 documentation files have metadata headers:
    grep -r "Configuration ID:" doc/ --include="*.md" | wc -l
    # Result: 28 (27 docs + 1 template in guidelines)

…entation files

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

@basheerFZ please review this pr , Thanks

@basheerFZ basheerFZ self-requested a review May 13, 2026 12:28
@basheerFZ basheerFZ added documentation Improvements or additions to documentation status:internal-review Ready for peer review. labels May 13, 2026
@basheerFZ basheerFZ added this to the Q1 (Milestone-1) milestone May 13, 2026
@basheerFZ basheerFZ linked an issue May 13, 2026 that may be closed by this pull request
15 tasks
@basheerFZ basheerFZ moved this from Todo to In Progress in timpani feature requirements May 13, 2026
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.

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

Comment thread doc/architecture/LLD/timpani-n/01-initialization-main.md
Comment thread doc/architecture/LLD/timpani-n/02-configuration-management.md
Comment thread doc/architecture/LLD/timpani-n/03-time-trigger-core.md
Comment thread doc/architecture/LLD/timpani-n/04-task-management.md
Comment thread doc/architecture/LLD/timpani-n/05-realtime-scheduling.md
Comment thread doc/architecture/timpani_rust_grpc_architecture.md
Comment thread doc/contribution/guidelines-en.md
Comment thread doc/docs/api.md
Comment thread doc/docs/structure.md
Comment thread doc/README.md
@basheerFZ basheerFZ removed the status:internal-review Ready for peer review. label May 13, 2026
@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor Author

@basheerFZ i have resolved the requested review comments with the new commit please check and merge , 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.

Changes are reflected

@github-project-automation github-project-automation Bot moved this from In Progress to Done in timpani feature requirements May 13, 2026
@basheerFZ basheerFZ merged commit 75e6519 into eclipse-timpani:development_0.5 May 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

[TASK] [DOCS]Add Documentation Metadata and Revision History

2 participants