Skip to content

docs: restructure, expand documentation #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
cdcabrera wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: restructure, expand documentation #81

cdcabrera wants to merge 1 commit into from
+2,172 −293

Conversation

@cdcabrera
Copy link
Member

@cdcabrera cdcabrera commented Jan 16, 2026 •
edited
Loading

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 mentioned this pull request Jan 19, 2026
Draft
@cdcabrera
Copy link
Member Author

cdcabrera commented Jan 19, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Refine and expand repository level documentation

1 participant

@cdcabrera