search

theupdateframework / python-tuf

Python reference implementation of The Update Framework (TUF)
https://theupdateframework.com/
Apache License 2.0
1.63k stars 272 forks source link

Enhance TUF Documentation with Architecture Diagrams and Visual Aids #2639

Open Ayush9026 opened 5 months ago

Ayush9026 commented 5 months ago

Description of issue or feature request: We need to enhance the documentation for The Update Framework (TUF) by adding architecture diagrams and other visual aids, aligning with the CNCF TechDocs Assessment criteria. These additions should be similar to those found in Kubernetes and Falco documentation to improve understanding and clarity for users and contributors.

Current behavior: The current documentation for TUF lacks detailed architecture diagrams and visual representations, making it challenging for users to grasp the system's design and components easily.

Expected behavior: We expect to see the addition of comprehensive architecture diagrams and other visual aids in the TUF documentation, similar to the ones found in Kubernetes and Falco documentation. These diagrams should clearly illustrate the system's architecture, key components, data flow, and interactions, providing an intuitive understanding of TUF's workings.

Ayush9026 commented 5 months ago

/assign @Ayush9026 i will raise PR for this issue.