-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor documentation #7417
Refactor documentation #7417
Conversation
Deploying with Cloudflare Pages
|
c91543c
to
470f7aa
Compare
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
89812c7
to
cc9c9bc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are still some links to usage:
pydantic/types.py
1541: 'See https://pydantic-docs.helpmanual.io/usage/types/extra_types/payment_cards/.',
pydantic/color.py
11: See [`pydantic-extra-types.Color`](../usage/types/extra_types/color_types.md)
73: 'See https://pydantic-docs.helpmanual.io/usage/types/extra_types/color_types/.',
pydantic/_internal/_generate_schema.py
253: f'`json_encoders` is deprecated. See https://docs.pydantic.dev/{version_short()}/usage/serialization/#custom-serializers for alternatives',
docs/plugins/main.py
235: if page.file.src_uri != 'usage/schema.md':
265: if page.file.src_uri != 'usage/conversion_table.md':
docs/blog/pydantic-v2.md
647:[`__get_validators__`](https://docs.pydantic.dev/usage/types/#classes-with-__get_validators__)
754:7. [Settings Management](https://docs.pydantic.dev/usage/settings/) ??? - I definitely don't want to
We should move "API documentation" up/left to just after concepts. |
I found this documentation system a while back that might be useful for this: https://documentation.divio.com/ it's a bit overwhelming, so I've generally cherry picked ideas, but I love the concept overall. |
Merging this, we can work on more stuff, from main. Still to do:
|
🚧 WIP
Checklist
mkdocs.yml
. See how to do it onpydantic/mkdocs.yml
Lines 211 to 212 in 3b297ad
Note
Should we really squash this?