asyncapi
[FEATURE] Automate Roadmap Page using GitHub Issues
Why do we need this improvement?
Currently, the Roadmap page roadmap.tsx is static and hardcoded within the codebase.
Updating the roadmap requires a developer to open a Pull Request and modify code, rather than just updating a project management tool. Because updates are manual, the website often lags behind the actual planning discussions happening on GitHub or in meetings. Maintainers have to track items in their project management workflows and manually update the website text separately.
How will this change help?
The website will reflect the latest status automatically as soon as labels are updated on GitHub (and the site is rebuilt). GitHub Issues will become the definitive source for roadmap items, eliminating the disconnect between the code and the plan. Users will be able to click through from the roadmap directly to the actual GitHub issue to see discussions, progress, and find ways to contribute.
Screenshots
No response
How could it be implemented/designed?
GitHub Convention:
Use a specific label to identify roadmap items e.g. area: roadmap
Use scoped labels to categorize status: roadmap: now roadmap: later, roadmap: future
Create a new script , leveraging the existing @octokit/graphql setup used in build-dashboard.ts
This script will run at build time, fetch all issues with the specific roadmap labels, and generate a JSON file (e.g., roadmap.json.
Refactor roadmap.tsx to consume the generated roadmap.json file instead of the hardcodedsolutions.
🚧 Breaking changes
Yes
👀 Have you checked for similar open issues?
- [x] I checked and didn't find a similar issue
🏢 Have you read the Contributing Guidelines?
- [x] I have read the Contributing Guidelines
Are you willing to work on this issue?
Yes I am willing to submit a PR!
Hi @princerajpoot20 Just wanted to follow up on this issue as well and check if you had any thoughts on the proposed feature or its implementation.
@sammy200-ui I did not clearly get what you are trying to convey. The roadmap page demonstrates the broader overall roadmap. If you change it to GitHub issue tags, then does it make sense? Who wants to read such minor, granular-level issues in detail?
Understand why these are there in the first place, then think of improving them. Right now, what you are suggesting will change the whole point of why we added the roadmap.
Hope it makes sense to you.
@princerajpoot20 I completely agree that the roadmap should remain high-level and strategic, focusing on Outcomes and Solutions rather than granular tasks.
My proposal isn't to list every minor bug or feature request on the roadmap page. Instead, I want to move the existing high-level content from roadmap.tsx into specific Epic style issues on GitHub.
How it would work:
We create specific issues that represent the current Outcomes and Solutions (e.g., an issue titled 'Outcome: Vision and roadmap are clear').
The rich text description currently in the code would be moved to the Issue Body.
We use labels like roadmap: outcome, roadmap: now, roadmap: later to manage them.
The website script would only fetch these specific high-level issues to generate the page.
This keeps the exact same high-level structure and narrative we have now,
but allows maintainers to update the status (e.g., moving an Outcome from 'Later' to 'Now') or tweak the text via the GitHub UI without needing a Pull Request and code deployment.