Skip to content

Conversation

@cdcabrera
Copy link
Member

@cdcabrera cdcabrera commented Jan 16, 2026

What is it?

  • docs: restructure, expand documentation

Notes

  • STILL REQUIRES, review and the entire guidelines directory for agents before merge
  • Retains some of the existing README.md content, just better breakdown.
  • Adds in
    • basic architecture, current and future
    • basic roadmap
    • expanded development docs and examples
  • Adds in a spell checker as part of the ci tests
  • Code examples are lint by the codebase configuration
  • Closes Refine and expand repository level documentation #39

@cdcabrera cdcabrera force-pushed the 20260116-issue-39 branch 2 times, most recently from a96d906 to 63a2b38 Compare January 19, 2026 03:34
@cdcabrera cdcabrera mentioned this pull request Jan 19, 2026
@cdcabrera
Copy link
Member Author

Move the typing update to an independent PR. It needs to be moved in as part of the 0.6.0 release.

@cdcabrera cdcabrera force-pushed the 20260116-issue-39 branch 3 times, most recently from 5861e93 to 4da19cd Compare January 21, 2026 00:37
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.

Refine and expand repository level documentation

1 participant