Skip to content

Commit cdd74e3

Browse files
committed
docs: modularize documentation and update project branding
This commit performs a major overhaul of the documentation architecture. The previous flat markdown files have been replaced by a structured series of numbered guides to improve discoverability and readability. Key changes: - Migrated content into 9 modular guides within the guides directory - Rewrote README.md for better clarity and faster onboarding - Added project branding assets, including a new SVG logo - Updated mix.exs to support grouped extras in HexDocs for better navigation - Refactored the examples catalog and updated the example index - Introduced a bash script to automate the execution of all examples - Removed redundant legacy documentation files This structure ensures that the documentation scales with the project and provides a clear learning path for both basic and advanced features.
1 parent 4abbb36 commit cdd74e3

18 files changed

Lines changed: 1959 additions & 6320 deletions

ADVANCED_FEATURES_GUIDE.md

Lines changed: 0 additions & 1182 deletions
This file was deleted.

GETTING_STARTED_GUIDE.md

Lines changed: 0 additions & 687 deletions
This file was deleted.

LLM_INTEGRATION_GUIDE.md

Lines changed: 0 additions & 2217 deletions
This file was deleted.

PRODUCTION_ERROR_HANDLING_GUIDE.md

Lines changed: 0 additions & 1113 deletions
This file was deleted.

README.md

Lines changed: 125 additions & 692 deletions
Large diffs are not rendered by default.

assets/exdantic.svg

Lines changed: 135 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)