Skip to content

Commit 0d88ab5

Browse files
committed
feat(docs): enhance documentation with grid layouts for framework and modeling sections
1 parent b5a6261 commit 0d88ab5

File tree

5 files changed

+147
-10
lines changed

5 files changed

+147
-10
lines changed

docs/getting-started.rst

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,39 @@ It's designed to work on its own or with your favorite web framework.
1818

1919
We've built extensions for some of the most popular frameworks, so you can get the most out of Advanced Alchemy with minimal effort.
2020

21-
* `Litestar <https://docs.litestar.dev/>`_
22-
* `FastAPI <https://fastapi.tiangolo.com/>`_
23-
* `Starlette <https://www.starlette.io/>`_
24-
* `Flask <https://flask.palletsprojects.com/>`_
25-
* `Sanic <https://sanicframework.org/>`_
21+
.. grid:: 1 1 2 2
22+
:padding: 0
23+
:gutter: 2
24+
25+
.. grid-item-card:: Litestar
26+
:link: https://docs.litestar.dev/
27+
:link-type: url
28+
29+
Async web framework with built-in Advanced Alchemy support
30+
31+
.. grid-item-card:: FastAPI
32+
:link: https://fastapi.tiangolo.com/
33+
:link-type: url
34+
35+
Modern async web framework with automatic API documentation
36+
37+
.. grid-item-card:: Starlette
38+
:link: https://www.starlette.io/
39+
:link-type: url
40+
41+
Lightweight async web framework and toolkit
42+
43+
.. grid-item-card:: Flask
44+
:link: https://flask.palletsprojects.com/
45+
:link-type: url
46+
47+
Lightweight sync web framework
48+
49+
.. grid-item-card:: Sanic
50+
:link: https://sanicframework.org/
51+
:link-type: url
52+
53+
High-performance async web framework
2654

2755
If your framework is not listed, don't worry! Advanced Alchemy is designed to be modular and easily integrated with any Python web framework.
2856
`Join our Discord <https://discord.gg/dSDXd4mKhp>`_ and we'll help you get started.

docs/usage/frameworks/index.rst

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,39 @@ Overview
1616

1717
Advanced Alchemy provides framework-specific extensions for:
1818

19-
- Litestar (async)
20-
- FastAPI (async)
21-
- Flask (sync)
22-
- Sanic (async)
23-
- Starlette (async)
19+
.. grid:: 1 1 2 2
20+
:padding: 0
21+
:gutter: 2
22+
23+
.. grid-item-card:: Litestar
24+
:link: litestar
25+
:link-type: doc
26+
27+
Async web framework integration
28+
29+
.. grid-item-card:: FastAPI
30+
:link: fastapi
31+
:link-type: doc
32+
33+
Async web framework integration
34+
35+
.. grid-item-card:: Flask
36+
:link: flask
37+
:link-type: doc
38+
39+
Sync web framework integration
40+
41+
.. grid-item-card:: Sanic
42+
:link: https://sanicframework.org/
43+
:link-type: url
44+
45+
Async web framework integration
46+
47+
.. grid-item-card:: Starlette
48+
:link: https://www.starlette.io/
49+
:link-type: url
50+
51+
Async web framework integration
2452

2553
Framework Comparison
2654
====================

docs/usage/modeling/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,34 @@ Advanced Alchemy enhances SQLAlchemy's modeling capabilities with production-rea
77
Learning Path
88
=============
99

10+
Follow this progression to master Advanced Alchemy modeling:
11+
12+
.. grid:: 1 1 3 3
13+
:gutter: 2
14+
15+
.. grid-item-card:: 1. Basics
16+
:link: basics
17+
:link-type: doc
18+
:text-align: center
19+
20+
Core concepts and simple models
21+
22+
.. grid-item-card:: 2. Relationships
23+
:link: relationships
24+
:link-type: doc
25+
:text-align: center
26+
27+
Connecting models together
28+
29+
.. grid-item-card:: 3. Advanced
30+
:link: advanced
31+
:link-type: doc
32+
:text-align: center
33+
34+
Complex patterns and optimization
35+
1036
.. toctree::
37+
:hidden:
1138
:maxdepth: 1
1239

1340
basics

docs/usage/repositories/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,34 @@ Advanced Alchemy's repository pattern provides a clean, consistent interface for
77
Learning Path
88
=============
99

10+
Follow this progression to master Advanced Alchemy repositories:
11+
12+
.. grid:: 1 1 3 3
13+
:gutter: 2
14+
15+
.. grid-item-card:: 1. Basics
16+
:link: basics
17+
:link-type: doc
18+
:text-align: center
19+
20+
CRUD operations and simple queries
21+
22+
.. grid-item-card:: 2. Filtering
23+
:link: filtering
24+
:link-type: doc
25+
:text-align: center
26+
27+
Pagination, sorting, and search
28+
29+
.. grid-item-card:: 3. Advanced
30+
:link: advanced
31+
:link-type: doc
32+
:text-align: center
33+
34+
Bulk operations and custom queries
35+
1036
.. toctree::
37+
:hidden:
1138
:maxdepth: 1
1239

1340
basics

docs/usage/services/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,34 @@ Services in Advanced Alchemy build upon repositories to provide higher-level bus
77
Learning Path
88
=============
99

10+
Follow this progression to master Advanced Alchemy services:
11+
12+
.. grid:: 1 1 3 3
13+
:gutter: 2
14+
15+
.. grid-item-card:: 1. Basics
16+
:link: basics
17+
:link-type: doc
18+
:text-align: center
19+
20+
Service pattern and basic CRUD
21+
22+
.. grid-item-card:: 2. Schemas
23+
:link: schemas
24+
:link-type: doc
25+
:text-align: center
26+
27+
Pydantic/msgspec integration
28+
29+
.. grid-item-card:: 3. Advanced
30+
:link: advanced
31+
:link-type: doc
32+
:text-align: center
33+
34+
Complex operations and hooks
35+
1036
.. toctree::
37+
:hidden:
1138
:maxdepth: 1
1239

1340
basics

0 commit comments

Comments
 (0)