Skip to content

docs: align README and roadmap with shipped functionality - #32

Merged
HecFranco merged 1 commit into
mainfrom
docs/readme-roadmap-sync
Aug 17, 2026
Merged

docs: align README and roadmap with shipped functionality#32
HecFranco merged 1 commit into
mainfrom
docs/readme-roadmap-sync

Conversation

@HecFranco

@HecFranco HecFranco commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Document wizard, constraint convention, static types; ROADMAP current state v2.4.1.

Test plan

  • README / roadmap match the current tag and CLI surface
  • No unrelated test or source changes in this PR

Summary by CodeRabbit

  • Documentation
    • Documented support for multi-step wizard forms.
    • Added guidance on constraint message conventions and static field types.
    • Updated the roadmap to reflect release v2.4.1 and planned form capabilities, including wizard, CSRF-only, GET-filter, and search query forms.

Keep the public docs in sync with the current tag: features, CLI commands, and roadmap status that were behind the code.
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e6ea5c21-a109-45a0-91dc-92da41f59d99

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 863a74b2-6ec4-40e4-a391-054bae9849c6

📥 Commits

Reviewing files that changed from the base of the PR and between d002161 and f543c63.

📒 Files selected for processing (2)
  • README.md
  • docs/ROADMAP.md

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README now documents multi-step forms and constraint message conventions. The roadmap now records v2.4.1 and additional form support.

Changes

Documentation updates

Layer / File(s) Summary
Feature and roadmap documentation
README.md, docs/ROADMAP.md
The README documents MultiStepFormBuilder, constraint_message_convention, #[FormKitConfig], and static field types. The roadmap records v2.4.1 and Wizard, CSRF-only, GET-filter, SearchQueryType, and static field type support.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to f543c

This change only updates documentation to reflect shipped functionality, with no actionable merge-blocking risk remaining beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation changes to the README and roadmap and matches the pull request objectives.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-roadmap-sync

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Already reviewed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@HecFranco
HecFranco merged commit 62e1dd6 into main Aug 17, 2026
19 of 20 checks passed
@HecFranco
HecFranco deleted the docs/readme-roadmap-sync branch August 17, 2026 21:15
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.

1 participant