Skip to content

Docs rewrite - #9

Merged
krypticmouse merged 6 commits into
krypticmouse:mainfrom
prrao87:docs-reorg
Sep 16, 2025
Merged

Docs rewrite#9
krypticmouse merged 6 commits into
krypticmouse:mainfrom
prrao87:docs-reorg

Conversation

@prrao87

@prrao87 prrao87 commented Sep 14, 2025

Copy link
Copy Markdown
Collaborator

This PR rewrites the docs inspire by the Diátaxis approach, with some modifications (rather than adding a separate "how-to guides" and "tutorials" sections, the "how-to guides" are merged into the "building blocks" section).

  • Rewrote quickstart guide with clearer examples and descriptions of each building block, and tested code examples
  • Reorged the page into relevant sections that offer a cleaner flow
  • Data (examples and predictions): WIP
  • Tutorials: WIP

More PRs to fill in the missing sections and more tutorials coming soon!

@krypticmouse
krypticmouse merged commit 222167f into krypticmouse:main Sep 16, 2025
1 check passed
@prrao87
prrao87 deleted the docs-reorg branch September 16, 2025 21:31
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