Skip to content

docs: consolidate RFCs + research into docs/rfcs/ + docs/research/ - #47

Merged
Arseni10Lk merged 0 commit into
mainfrom
docs/rfcs-and-research
Sep 3, 2026
Merged

Arseni10Lk merged 0 commit into
mainfrom
docs/rfcs-and-research

Conversation

@aligatoralex

Copy link
Copy Markdown
Contributor

Description of Changes:

Consolidates 7 separate docs-only draft PRs (#31, #33, #36, #38, #40, #42, #45), each on its own long-lived branch for a single markdown file, into one PR. This closes the gap between how this repo was accumulating design-proposal PRs/branches and how mature open-source projects actually do it.

Research behind this change: reviewed Rust RFCs (rust-lang/rfcs), Python PEPs (python/peps), Kubernetes KEPs (kubernetes/enhancements), and ADRs (adr.github.io). Common thread: none keep a proposal document on a long-lived, dedicated branch. A branch exists only long enough to open one PR; the document then lives as a file on main, and later changes (status updates, corrections) are small follow-up PRs to that same file — not new branches. This team already discusses in Issues rather than PR threads, which maps cleanly onto the ADR convention (discussion wherever the team prefers) rather than Rust's PR-thread-only model.

What this PR does:

Follow-up (next, after this merges): close PRs #31/#33/#36/#38/#40/#42/#45 with a comment pointing here, delete their branches, and update issues #37/#39/#41/#46 to link the new file paths instead of the old branches.

Checklist:

  • I have run uv run pytest YAADO_Core/tests/ and all tests pass. (Docs-only; 102 passed.)
  • My code includes type hints and docstrings. (N/A — Markdown.)
  • I added all vital READMEs. (Adds docs/rfcs/README.md.)

Verification method:
Ran the full suite on this branch (102 passed, unaffected — no code touched). Cross-checked every docs/rfc/ path reference across all consolidated files and updated them; verified no other file references the old singular path after the edit.


Generated by Claude Code

@Arseni10Lk Arseni10Lk closed this Sep 3, 2026
@Arseni10Lk
Arseni10Lk force-pushed the docs/rfcs-and-research branch from 2686ce9 to 0ee8739 Compare September 3, 2026 11:18
@Arseni10Lk
Arseni10Lk merged commit a417522 into main Sep 3, 2026
@Arseni10Lk
Arseni10Lk deleted the docs/rfcs-and-research branch September 3, 2026 11:18
@Arseni10Lk

Copy link
Copy Markdown
Member

I had to clean the repo of the proprietary data from docs/ from the past. So the whole history was rebased

@aligatoralex

aligatoralex commented Sep 3, 2026 via email

Copy link
Copy Markdown
Contributor Author

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.

2 participants