Add FAQ explaining why Pydantic is not used #1489
Merged
+65
−18
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
Added an FAQ entry explaining why the project avoids using Pydantic, highlighting reasons such as dependency minimization, avoiding version conflicts, and preferring built-in alternatives like
TypedDict
.Checklist
Code Changes
poetry all
locally to ensure this change passes linter check and testsDocumentation Changes
poetry doc
locally to ensure the documentation pages render correctlyExpected Behavior
The FAQ page should render correctly and clearly explain why Pydantic is not used in the project.
Steps to Test This Pull Request
poetry doc
faq.md
Additional Context
Closes: #1488