Skip to content

Add LLM-generated detailed architecture documentation#868

Open
juniper-shopify wants to merge 2 commits into
juni/06-19-fix_valid_provider_raising_argumenterror_instead_of_invalidconfigerrorfrom
juni/Add_LLM-generated_detailed_architecture_documentation
Open

Add LLM-generated detailed architecture documentation#868
juniper-shopify wants to merge 2 commits into
juni/06-19-fix_valid_provider_raising_argumenterror_instead_of_invalidconfigerrorfrom
juni/Add_LLM-generated_detailed_architecture_documentation

Conversation

@juniper-shopify

@juniper-shopify juniper-shopify commented May 7, 2026

Copy link
Copy Markdown
Contributor

This PR adds some detaield LLM-generated documentation for the Roast codebase. I've run multiple AI deep dives on generation and several passes of automated review and validation on it. I'm not 100% sure it's all correct, but I think it's worth having, as coding agens often have difficulty working with Roast's metaprogramming internals, and this should help more than it hurts

juniper-shopify commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

@juniper-shopify juniper-shopify marked this pull request as ready for review May 7, 2026 19:51
@juniper-shopify juniper-shopify marked this pull request as draft May 7, 2026 19:51
@juniper-shopify juniper-shopify changed the title Add LLM-generated detailed architecture documentation [DRAFT] Add LLM-generated detailed architecture documentation May 7, 2026
@juniper-shopify juniper-shopify force-pushed the juni/Add_LLM-generated_detailed_architecture_documentation branch from 1d72a78 to cd2e429 Compare May 7, 2026 19:56
@juniper-shopify juniper-shopify changed the base branch from juni/Add_subdir_for_comments-related_internal_documentation to graphite-base/868 May 20, 2026 15:56
@juniper-shopify juniper-shopify marked this pull request as ready for review May 20, 2026 15:56
@juniper-shopify juniper-shopify force-pushed the juni/Add_LLM-generated_detailed_architecture_documentation branch from cd2e429 to c0b44a8 Compare May 20, 2026 15:58
@graphite-app graphite-app Bot changed the base branch from graphite-base/868 to main May 20, 2026 15:59
@juniper-shopify juniper-shopify force-pushed the juni/Add_LLM-generated_detailed_architecture_documentation branch from c0b44a8 to 4f4494e Compare May 20, 2026 15:59
Comprehensive review of all 12 documentation files in
internal/documentation/architecture/, correcting:

- Line number drift (systemic across all files)
- Incorrect method/class counts and arithmetic
- Outdated dependency versions (ruby_llm >=1.8 -> >=1.13)
- Missing dependencies and providers
- Behavioral inaccuracies (e.g., all three cog accessor
  variants block on async, not just the bang variant)
- Stale 'known issue' entries for bugs already fixed
- Removed sig/generated/ section (gitignored, not present
  on most developer machines)
@juniper-shopify juniper-shopify changed the base branch from main to graphite-base/868 June 19, 2026 20:16
@juniper-shopify juniper-shopify force-pushed the juni/Add_LLM-generated_detailed_architecture_documentation branch from 4f4494e to e45683d Compare June 19, 2026 20:16
@juniper-shopify juniper-shopify changed the base branch from graphite-base/868 to juni/06-19-fix_valid_provider_raising_argumenterror_instead_of_invalidconfigerror June 19, 2026 20:19
@juniper-shopify juniper-shopify changed the title [DRAFT] Add LLM-generated detailed architecture documentation Add LLM-generated detailed architecture documentation Jun 19, 2026
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