Skip to content

docs: add public ROADMAP.md with stability queue and optional AI direction#26

Merged
EtienneLescot merged 1 commit into
mainfrom
docs/roadmap
Jun 24, 2026
Merged

docs: add public ROADMAP.md with stability queue and optional AI direction#26
EtienneLescot merged 1 commit into
mainfrom
docs/roadmap

Conversation

@EtienneLescot

@EtienneLescot EtienneLescot commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Single squashed commit that lands:

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:

  • \DISCORD_ROADMAP_WEBHOOK_URL\ — webhook URL of the #🗺️・roadmap\ channel on the OpenScreen Discord.

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

  • Rendered locally in VS Code markdown preview — headings, links, and checkboxes display correctly.
  • All GitHub URLs verified to resolve to the correct issues / PRs / Actions page.
  • YAML validated locally with Python (\yaml.safe_load) — 3 jobs detected:
    otify, \weekly-contributor-leaderboard,
    oadmap-notify.
  • Workflow syntax will be re-validated by GitHub Actions on PR open.

- 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.
@EtienneLescot EtienneLescot merged commit 6625485 into main Jun 24, 2026
8 checks passed
@EtienneLescot EtienneLescot deleted the docs/roadmap branch June 24, 2026 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant