Skip to content

Refresh README and set up PR-based release notes#2

Merged
paracycle merged 1 commit into
mainfrom
docs-and-pr-workflow
Jul 8, 2026
Merged

Refresh README and set up PR-based release notes#2
paracycle merged 1 commit into
mainfrom
docs-and-pr-workflow

Conversation

@paracycle

Copy link
Copy Markdown
Member

Housekeeping to adopt a PR-based workflow.

  • README: fix the Roadmap section (it linked to docs/ROADMAP.md/docs/CHECKLIST.md, which are kept local/untracked, so the links 404); inline a short "Not yet supported" list instead. Add a note about the optional GraphProvider::expand_in hook.
  • .github/release.yml: categorize auto-generated release notes (Breaking/Features/Performance/Fixes/Docs) by PR label.

First PR in the new flow (dogfooding it).

- README: replace the Roadmap section's links to the (intentionally
  local, untracked) docs/ROADMAP.md and docs/CHECKLIST.md with an inline
  "Not yet supported" list, so the README has no broken links; note the
  optional GraphProvider::expand_in perf hook.
- Add .github/release.yml so the release workflow's --generate-notes
  groups merged PRs into Breaking/Features/Performance/Fixes/Docs sections.
@paracycle paracycle added the documentation Improvements or additions to documentation label Jul 8, 2026
@paracycle paracycle merged commit 62f4afb into main Jul 8, 2026
2 checks passed
@paracycle paracycle deleted the docs-and-pr-workflow branch July 8, 2026 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant