Skip to content

Add documentation & HTTP status FormNotFoundError now 404 - #69

Merged
Mark90 merged 9 commits into
mainfrom
documentation
Aug 7, 2026
Merged

Add documentation & HTTP status FormNotFoundError now 404#69
Mark90 merged 9 commits into
mainfrom
documentation

Conversation

@Mark90

@Mark90 Mark90 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Add documentation to the project and make it work as a subproject of https://github.com/workfloworchestrator/workfloworchestrator.github.io.

Initial documentation generated with Claude Code followed by lots of redactions.

Code blocks in the markdown documentation consist of normal python blocks followed by pycon (Python Console) blocks which demonstrate assertions on previous code blocks, and which are validated through a unit test / pre-commit hook.

Code changes

  • Form generator now raises FormNotFoundError instead of FormException
  • FormPage.meta__ now a default ClassVar (no impact on schema or serialization) and documented
  • form_error_handler reworked and added handling of FormNotFoundError (404 now instead of 500)
  • Lots of docstrings

Screenshots

Intro page

image

Usage

image

Examples

image

Reference page

image

Search (project name prefix is a CSS hack, see monorepo PR )

image

Neat unexpected side-effect (might be a bit hard to see): mkdocs is now able link from orchestrator-core's reference docs to a type in pydantic-forms that it uses

image

@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.52%. Comparing base (27ee42d) to head (2ab8a1e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #69      +/-   ##
==========================================
+ Coverage   91.82%   94.52%   +2.70%     
==========================================
  Files          33       33              
  Lines         697      731      +34     
  Branches       71       71              
==========================================
+ Hits          640      691      +51     
+ Misses         52       31      -21     
- Partials        5        9       +4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Mark90 Mark90 changed the title Documentation Add documentation & HTTP status FormNotFoundError now 404 Aug 6, 2026
@Mark90
Mark90 marked this pull request as ready for review August 6, 2026 14:00
@eenblam
eenblam self-requested a review August 6, 2026 16:20
eenblam
eenblam previously approved these changes Aug 6, 2026

@eenblam eenblam left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I haven't had time to exercise this locally today, but it looks good! I left some comments with suggestions and questions, but I don't see any of them as blocking.

Comment thread docs/errors.md Outdated
Comment thread docs/examples.md
Comment thread pydantic_forms/validators/components/choice.py
Comment thread pydantic_forms/validators/components/timestamp.py
Comment thread pydantic_forms/core/sync.py
Comment thread docs/usage.md
@Mark90
Mark90 merged commit 9080058 into main Aug 7, 2026
18 checks passed
@Mark90
Mark90 deleted the documentation branch August 7, 2026 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants