docs: move planning to GitHub issues - #325
Merged
Merged
Conversation
lbliii
marked this pull request as ready for review
August 7, 2026 14:19
There was a problem hiding this comment.
Pull request overview
This PR updates Kida’s repository planning posture by making GitHub Issues the source of truth for active work, while keeping only durable design/audit records in-repo. It primarily moves/retargets internal references from plan/ to docs/design/ and docs/audit/, and removes stale planning/backlog artifacts.
Changes:
- Retarget doc/test/source references from
plan/*documents to the new historical records underdocs/design/anddocs/audit/. - Replace the
plan/index with a planning policy (plan/README.md) and remove stale RFC/epic/roadmap/research backlogs fromplan/. - Adjust documentation-site content and config to match the new record locations.
Reviewed changes
Copilot reviewed 84 out of 84 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_yield_directive.py | Update RFC reference to new docs/design/ location. |
| tests/test_sandbox_fuzz.py | Update design rationale reference to docs/design/. |
| tests/test_render_surface_parity.py | Update corpus rationale references to docs/audit/ + docs/design/. |
| src/kida/parser/tokens.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/statements.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/expressions.py | Update “See:” references to docs/design/ record. |
| src/kida/parser/blocks/variables.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/template_structure.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/special_blocks.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/i18n.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/functions.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/error_handling.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/core.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/blocks/control_flow.py | Update “See:” reference to docs/design/ record. |
| src/kida/parser/_protocols.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/with_blocks.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/variables.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/template_structure.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/special_blocks.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/pattern_matching.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/i18n.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/functions.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/error_handling.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/control_flow.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/caching.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/basic.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/statements/init.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/expressions.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/coalescing.py | Update “See:” reference to docs/design/ record. |
| src/kida/compiler/_protocols.py | Update “See:” reference to docs/design/ record. |
| site/content/docs/tutorials/refactor-safe-templates.md | Update design doc pointer to docs/design/. |
| site/content/docs/advanced/t-strings.md | Update epic link to docs/audit/ path. |
| site/config/_default/external_refs.yaml | Remove in-repo RFC pointer; replace with external repo history note. |
| plan/rfc-typed-def-parameters.md | Removed stale in-repo plan document. |
| plan/rfc-type-suppression-reduction.md | Removed stale in-repo plan document. |
| plan/rfc-type-checking-strategy.md | Removed stale in-repo plan document. |
| plan/rfc-tstring-dogfooding.md | Removed stale in-repo plan document. |
| plan/rfc-tojson-attr-safe.md | Removed stale in-repo plan document. |
| plan/rfc-test-coverage-hardening.md | Removed stale in-repo plan document. |
| plan/rfc-terminal-tutorial-outline.md | Removed stale in-repo plan document. |
| plan/rfc-template-helpers-any-reduction.md | Removed stale in-repo plan document. |
| plan/rfc-saga-benchmarks.md | Removed stale in-repo plan document. |
| plan/rfc-report-contract-hardening.md | Removed stale in-repo plan document. |
| plan/rfc-region-blocks-parameter.md | Removed stale in-repo plan document. |
| plan/rfc-milo-vision-diff.md | Removed stale in-repo plan document. |
| plan/rfc-list-comprehensions.md | Removed stale in-repo plan document. |
| plan/rfc-large-template-optimization.md | Removed stale in-repo plan document. |
| plan/rfc-flush-directive.md | Removed stale in-repo plan document. |
| plan/rfc-canonical-component-catalog.md | Removed stale in-repo plan document. |
| plan/rfc-c-escaping-extension.md | Removed stale in-repo plan document. |
| plan/research-playground-feasibility.md | Removed stale in-repo plan document. |
| plan/release-0.10.0-roadmap.md | Removed stale in-repo plan document. |
| plan/README.md | Replace plan index with policy + link to GitHub Issues. |
| plan/epic-template-framework-gaps.md | Removed stale in-repo plan document. |
| plan/epic-pre-1.0-stabilization.md | Removed stale in-repo plan document. |
| plan/epic-partial-eval-enhancement.md | Removed stale in-repo plan document. |
| plan/epic-large-app-ergonomics.md | Removed stale in-repo plan document. |
| plan/epic-kida-milo-integration.md | Removed stale in-repo plan document. |
| plan/epic-i18n-completion.md | Removed stale in-repo plan document. |
| docs/strategic-roadmap.md | Remove closed roadmap (planning now in issues). |
| docs/README.md | Update docs index to point active planning to GitHub Issues. |
| docs/kida-render-product.md | Reframe as historical record; direct future bets to issues. |
| docs/design/rfc-yield-directive.md | Reframe as historical design record; note planning is in issues. |
| docs/design/rfc-relative-template-resolution.md | Reframe as historical design record; remove plan-era cross-links. |
| docs/design/rfc-mixin-protocol-typing.md | Reframe as historical design record; note planning is in issues. |
| docs/design/design-render-surface-hardening.md | Reframe as historical design record; adjust links to audit record. |
| docs/audit/epic-tstring-dogfooding.md | Reframe as historical delivery record; remove plan-era “source” pointer. |
| docs/audit/epic-render-surface-hardening.md | Reframe as historical delivery record; update design-note pointer. |
| CHANGELOG.md | Update link to the new docs/design/ record location. |
Suppressed comments (1)
docs/design/design-render-surface-hardening.md:215
- The Acceptance checklist is marked as incomplete (
[ ]) even though this document now describes a completed historical record and the first item states it was satisfied “with this commit”. That’s internally inconsistent and can confuse readers skimming for current status.
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
Why
Repository-backed plans had become stale and duplicated the GitHub backlog. The remaining repository records now document maintained behavior or durable evidence rather than active work queues.
Validation
uv run pytest tests/stewards -qmake format-checkmake lintmake tymake docs(build completed; existing site health output reports unrelated broken internal links)