docs: overhaul usage documentation #590
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add custom types documentation for Advanced Alchemy - Introduced basic types: GUID, DateTimeUTC, JsonB, BigIntIdentity. - Added file storage types: FileObject, FileObjectList, StoredObject. - Documented security types: EncryptedString, EncryptedText, PasswordHash. - Created index for custom types with quick reference and database compatibility. - Included usage examples and integration patterns for each type.
**Reference Documentation Enhancements:** - Add standalone CLI reference documentation with usage examples - Enhance types reference with organized sections for all type categories - Enhance base reference with explicit documentation for all base classes - Add explicit class documentation to resolve cross-reference warnings **Fixes:** - Remove 5 orphaned usage files from previous reorganization - Fix unknown document references in getting-started.rst and index.rst - Fix document references in modeling docs (../types → ../types/index) - Fix SQL lexing error in migrations.rst with proper tab-set syntax - Add :no-index: to CLI functions to prevent duplicate documentation **Storage Documentation:** - Add comprehensive MinIO configuration examples - Fix framework integration examples in obstore.rst - Add tab-set for Litestar and FastAPI file upload patterns - Correct tag pattern example to show UniqueMixin value **Build Results:** - Reduced warnings from 19+ to 8 (only optional dependencies) - Zero critical errors - Zero cross-reference issues for core classes - Clean build with proper tab rendering Resolves documentation completeness issues identified in Phase 3+ audit.
… modeling sections
github-actions
bot
added
area/ci
area/docs
area/tools
size: large
pr/external
Triage Required 🏥
labels
8 tasks
Harshal6927
changed the title
Signed-off-by: Cody Fincher <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #590 +/- ##
==========================================
+ Coverage 79.26% 79.67% +0.41%
==========================================
Files 87 87
Lines 6355 6392 +37
Branches 810 824 +14
==========================================
+ Hits 5037 5093 +56
+ Misses 1068 1043 -25
- Partials 250 256 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/advanced-alchemy-docs-preview/590 |
cofin
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes