Feature tracking & progress overview

[brenocq]

I'm considering upgrading the README to make it easier for newcomers to see what's actively being worked on and track the progress of various features.

The idea:

• A dynamically updating image in the README that displays:
  • The number of features marked as todo, in progress, and done.
  • A list of the 5 most recently active feature discussions.
  • Each feature name will link directly to its corresponding discussion thread for easy access.

How it would work:

• The image will update automatically whenever labels are changed in discussions under the "Features and Improvements" category.
• This way, the README will always reflect the current state of development without manual updates.

[brenocq]

The README now shows live-updating SVG cards that track the status of feature discussions in the "Features and Improvements" category. This makes it easy to see what’s being worked on without needing to manually update the README.

How does it work?

GitHub Discussions Integration:

A GitHub Action listens for updates to discussions and comments in the "Features and Improvements" category. When discussions are created, edited, or when their labels change, the workflow triggers an update.

Dynamic SVG Generation:

A Python script fetches the latest discussions via the GitHub GraphQL API. It then generates SVG cards showing counts for features marked as todo, doing, review, and done. The cards are saved as .svg files with the status label and uploaded to Google Cloud Storage (GCS).

Google Cloud Deployment:

A Flask app hosted on Google Cloud Run serves as a redirect layer. It listens for requests to URLs like implot3d.brenocq.com/discussion_0, downloads the corresponding SVG from GCS, and redirects users to the actual GitHub discussion.

Automatic Updates:

Each time a relevant discussion is updated, the GitHub Action regenerates and uploads the SVGs, ensuring the README always displays the most up-to-date information.

Interactive and Informative:

Clicking on any card in the README leads directly to filtered discussions or specific feature threads, providing a seamless way to track development progress.

It’s a simple way to keep the project’s roadmap visible and up-to-date, with zero manual effort after setup :)

[brenocq]

⚠️ Camo Cache Issue with README Images

I've noticed that the discussion status images in the README aren't always up to date, so the user would click the image for one discussion, but be redirected to another. This happens because GitHub proxies external images through camo.githubusercontent.com, which aggressively caches them. Even when the source SVG at https://storage.googleapis.com/... is updated, the cached camo version lags behind.

I tried to fix it by downloading the camo SVG images from the client-side in the redirect link implot3d.brenocq.com/discussions_X. However, directly downloading the updated SVG via JavaScript from the client side doesn't work because of CORS restrictions.

Potential Solution

To bypass this issue, we could host the images in a GitHub repository instead of Google Storage. By using:

https://raw.githubusercontent.com/brenocq/repo-name/main/discussion_0.svg

The images would load directly, bypassing camo entirely and reflecting updates immediately. The only downside is the need for another repo to host the images, which would receive a new commit when the workflow is run (I'm trying to avoid a lot of automated commits in this repo).