Skip to content
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

Merged
merged 25 commits into from Sep 24, 2023
Merged

Refactor documentation #7417

merged 25 commits into from Sep 24, 2023

Conversation

Kludex
Copy link
Member

@Kludex Kludex commented Sep 12, 2023

🚧 WIP

Checklist

  • Remember to check if all redirect links are included on the mkdocs.yml. See how to do it on

    pydantic/mkdocs.yml

    Lines 211 to 212 in 3b297ad

    'usage/validation_errors.md': 'errors/validation_errors.md'
    'usage/errors.md': 'errors/usage_errors.md'
    .

Note

Should we really squash this?

@Kludex Kludex changed the title Removing booleans.md (#7408) Refactor documentation Sep 12, 2023
@cloudflare-pages
Copy link

cloudflare-pages bot commented Sep 15, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: f849608
Status: ✅  Deploy successful!
Preview URL: https://33924420.pydantic-docs2.pages.dev
Branch Preview URL: https://refactor-docs.pydantic-docs2.pages.dev

View logs

sydney-runkle and others added 19 commits September 22, 2023 14:56
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Hasan Ramezani <hasan.r67@gmail.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com>
Co-authored-by: sydney-runkle <54324534+sydney-runkle@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
@samuelcolvin samuelcolvin mentioned this pull request Sep 22, 2023
7 tasks
Copy link
Member

@samuelcolvin samuelcolvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@samuelcolvin samuelcolvin marked this pull request as ready for review September 22, 2023 16:57
@samuelcolvin samuelcolvin enabled auto-merge (squash) September 22, 2023 16:59
Copy link
Member

@samuelcolvin samuelcolvin left a 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

@samuelcolvin
Copy link
Member

We should move "API documentation" up/left to just after concepts.

@RitikShah
Copy link

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.

@samuelcolvin
Copy link
Member

Merging this, we can work on more stuff, from main.

Still to do:

  • move more stuff from concepts to API docs
  • check all old pages have redirects

@samuelcolvin samuelcolvin merged commit 9c91f85 into main Sep 24, 2023
60 checks passed
@samuelcolvin samuelcolvin deleted the refactor-docs branch September 24, 2023 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants