Skip to content

chore(docs): add ADRs and proposals sections in reference docs#1243

Merged
tobz merged 4 commits into
mainfrom
tobz/docs-autogen-adrs-plans-toc-20260312
Mar 12, 2026
Merged

chore(docs): add ADRs and proposals sections in reference docs#1243
tobz merged 4 commits into
mainfrom
tobz/docs-autogen-adrs-plans-toc-20260312

Conversation

@tobz
Copy link
Copy Markdown
Member

@tobz tobz commented Mar 12, 2026

Summary

This PR adds a section to the reference documentation for both ADRs and "proposals."

I decided to split apart the combined ADRs-and-plans section into two, since they do end up being materially different in terms of content and the process surrounding them. We've added all the necessary template boilerplate so that we can auto-generate the table of contents for each, and we have a starting template for people to use when creating an ADR or a proposal.

Happily, LLMs seem to do pretty good referencing the instructions given in each section and being able to in turn generate an ADR or proposal. To wit, our first ADR describing why we added these sections was generated as a rough draft by Claude. 🤖

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

How did you test this PR?

N/A

References

N/A

@tobz tobz requested a review from a team as a code owner March 12, 2026 18:05
@tobz tobz added the type/chore Updates to dependencies or general "administrative" tasks necessary to maintain the codebase/repo. label Mar 12, 2026
@dd-octo-sts dd-octo-sts Bot added the area/docs Reference documentation. label Mar 12, 2026
@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented Mar 12, 2026

Binary Size Analysis (Agent Data Plane)

Target: 4ce5a06 (baseline) vs 234d994 (comparison) diff
Analysis Type: Stripped binaries (debug symbols excluded)
Baseline Size: 26.19 MiB
Comparison Size: 26.19 MiB
Size Change: +0 B (+0.00%)
Pass/Fail Threshold: +5%
Result: PASSED ✅

Changes by Module

Module File Size Symbols

Detailed Symbol Changes

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

@tobz tobz merged commit 47e1930 into main Mar 12, 2026
58 of 59 checks passed
@tobz tobz deleted the tobz/docs-autogen-adrs-plans-toc-20260312 branch March 12, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Reference documentation. type/chore Updates to dependencies or general "administrative" tasks necessary to maintain the codebase/repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants