Repository navigation
Enhancing The Update Framework (Python - TUF) README #2654
Description
Description of issue or feature request:
I would like to request an enhancement for the README of The Update Framework (TUF) repository. The goal is to improve the structure, clarity, and accessibility of the README to make it more informative and user-friendly.
Current behavior:
The current README lacks a clear structure, making it difficult for users to navigate and find relevant information quickly. Additionally, some sections could be more concise.
Expected behavior:
I propose the following changes to enhance the README:
- Add a Table of Contents: Improve navigation and accessibility.
- Improve the Introduction: Provide a clear and concise overview of TUF in 2 - 3 lines.
- Expand the "About TUF" Section: Add more context about its significance and applications.
- Highlight Key Features: Create a section listing key features and benefits.
- Reorganize the Documentation Section: Enhance user-friendliness and navigation.
- Add Visuals: Incorporate diagrams or images for better understanding.
- Change Logo Color: Modify the logo from black to white to enhance visibility.
- Add Badges: Include additional badges to highlight key aspects like version, license, tech-stack and community support.
Activity
[-]Enhancing The Update Framework (TUF) README[/-][+]Enhancing The Update Framework (Python - TUF) README[/+]shubhusion commentedon Jun 8, 2024
@trishankatdatadog please review this issue and let me know if I can work on this.
trishankatdatadog commentedon Jun 8, 2024
Let's try it and see 🙂
shubhusion commentedon Jun 8, 2024
Thanks @trishankatdatadog I will work on it
K-letir-rgb commentedon Aug 26, 2026
Hi I noticed PR #2655 addressed most of this but was closed due to inactivity, with a couple of open review comments (broken image links, CNCF section placement). I'd love to pick this up fresh if that's alright - I can review jku's feedback there and make sure those points are addressed this time.
jku commentedon Aug 26, 2026
If you do, please aim for minimal PRs: 2655 combined a lot of things in one and did not get merged because of it.
Note that the list in this issue is not a list requirements: they're just ideas that may or may not make sense.
K-letir-rgb commentedon Aug 26, 2026
Noted, i will begin to work on it immediately. Thankyou.