Skip to content

docs: add GitBook documentation suite and clean up README - #32

Merged
eliasjpr merged 1 commit into
masterfrom
docs/gitbook-documentation
Nov 2, 2026
Merged

eliasjpr merged 1 commit into
masterfrom
docs/gitbook-documentation

Conversation

@eliasjpr

@eliasjpr eliasjpr commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds comprehensive documentation under docs/ structured into Tutorials, How-To Guides, Reference, and Explanation.
  • Configures the repository for GitBook Git Sync via .gitbook.yaml and docs/SUMMARY.md, using native GitBook features (YAML frontmatter with icons, {% stepper %}, {% tabs %}, {% hint %}, <table data-view="cards">, <details>, {% content-ref %}, and Mermaid diagrams).
  • Unignores /docs/ in .gitignore so GitBook can sync documentation from the repository.
  • Rewrites README.md to be a clean, accurate entry point with verified code examples, capabilities matrix, endpoint summary, and links to all documentation sections.

@eliasjpr
eliasjpr merged commit aa2be2f into master Nov 2, 2026
3 checks passed
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.

1 participant