-
Notifications
You must be signed in to change notification settings - Fork 8
Docs: README roadmap #131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: README roadmap #131
Conversation
Signed-off-by: Breno Cunha Queiroz <Breno1423@gmail.com>
…cs/readme-roadmap
Signed-off-by: Breno Cunha Queiroz <Breno1423@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the project documentation by integrating dynamic SVG roadmap images in the README, which automatically reflect the current status of issues and tasks. Key changes include:
- Updating README.md to embed dynamically generated SVG images for status and issue cards.
- Adding a GitHub Actions workflow to generate and deploy SVGs to a dedicated branch.
- Implementing new Python scripts for fetching GitHub issue data and rendering interactive SVG status and issue cards.
Reviewed Changes
Copilot reviewed 8 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updated to embed new dynamic SVG images and improved progress section presentation. |
| .github/workflows/update-readme.yml | Added workflow to trigger on relevant GitHub events and push SVG updates to a detached branch. |
| .github/scripts/readme_svgs/gen_status_cards.py | New script to generate status card SVGs using GitHub issue status data. |
| .github/scripts/readme_svgs/gen_issue_cards.py | New script to generate detailed issue card SVGs with interactive features. |
| .github/scripts/readme_svgs/common.py | New module defining style constants and helper functions for SVG generation. |
| .github/scripts/updateReadmeButtons/updateReadmeButtons.py | Removed legacy script no longer needed for the new roadmap system. |
Files not reviewed (6)
- .github/scripts/.gitignore: Language not supported
- .github/scripts/readme_svgs/.gitignore: Language not supported
- .github/scripts/readme_svgs/requirements.txt: Language not supported
- .github/scripts/updateReadmeButtons/decrypt_secret.sh: Language not supported
- .github/scripts/updateReadmeButtons/requirements.txt: Language not supported
- .github/workflows/updateReadmeButtons.yml: Language not supported
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Breno Cunha Queiroz <Breno1423@gmail.com>
|



Feat: Add Dynamic SVG Roadmap to README
Closes #63
This PR improves the README section to provide real-time updates of Atta's development, since we moved from GitHub projects to GitHub issues to track tasks, it was necessary to also update the README progress images.
The previous progress tracking was very simple and would just show the development progress for each Atta module
The new progress section provides information about the tasks that are being worked on, and better follows the GitHub UI (I honestly think it looks sick)
Functionality:
.github/workflows/update-readme.yml) triggers on relevant issue events (creation, updates, labels, comments).status:todo,status:doing).roadmap-svgs).README.mdnow embeds these SVG images using direct links to the raw files on theroadmap-svgsbranch. This allows the README content to update visually whenever the SVGs are regenerated, without adding SVG churn to themainbranch history.redirect.brenocq.comto parse the SVG and extract the issue link to redirect.This system ensures the README provides a valuable, real-time insight into the project's development landscape.
🔧 Changelog
README.mdto embed the dynamically generated roadmap SVGs.roadmap-svgsbranch.