docs: add public ROADMAP.md with stability queue and optional AI direction#26
Merged
Conversation
6f9dfd8 to
7f32282
Compare
- Add ROADMAP.md at repo root for top-level discoverability. - Stability queue pulled from open issues / PRs on getopenscreen/openscreen (#8, #21, #22, #19, #18, #24). - AI direction framed as opt-in / off by default, with per-feature tags. - Link the new roadmap from the README Community section. - Extend .github/workflows/discord.yaml with a roadmap-notify job that posts an embed to the #🗺️・roadmap Discord channel whenever a PR changes ROADMAP.md (or docs/roadmap.md). Mirrors the existing PR -> #pr-reviews sync pattern. Activated by setting the DISCORD_ROADMAP_WEBHOOK_URL repo secret; silently skipped otherwise so CI never breaks.
7f32282 to
5c4370a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Single squashed commit that lands:
oadmap-notify\ job in .github/workflows/discord.yaml\ that auto-posts an embed to the #🗺️・roadmap\ Discord channel whenever a PR changes \ROADMAP.md\ (or \docs/roadmap.md). Mirrors the existing PR → #🔎・pr-reviews\ sync pattern.
Why root, not \docs/\
The user asked for the roadmap to be at the repo root (\ROADMAP.md) so it's a top-level discoverable artifact — the standard OSS pattern. \docs/\ is reserved for engineering deep-dives and native recorder roadmaps.
Required setup for the new auto-post
To activate the Discord auto-post, add a new repo secret:
Until that secret is set, the workflow logs \DISCORD_ROADMAP_WEBHOOK_URL not set; skipping roadmap notify.\ and does nothing — no CI failures.
Test plan
otify, \weekly-contributor-leaderboard,
oadmap-notify.