Skip to content

fix(xtask): restore filter doc generation for AI repo#238

Open
leseb wants to merge 4 commits into
mainfrom
leseb/fix-filters-doc-generation
Open

fix(xtask): restore filter doc generation for AI repo#238
leseb wants to merge 4 commits into
mainfrom
leseb/fix-filters-doc-generation

Conversation

@leseb

@leseb leseb commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restores filter_docs.rs xtask module deleted during the monorepo migration (commit 28377b0)
  • Adapts the doc generator for the two-crate layout (apis + filters) with flat output to docs/filters/{name}.md
  • Scans praxis core's payload_processing dir so OnInvalidBehavior enum variants are expanded in config tables
  • Removes stale json_rpc.md (filter moved to praxis core)
  • Regenerates all 18 filter docs and the reference index

Test plan

  • cargo xtask generate-filter-docs discovers 18 filters and generates docs
  • cargo xtask lint-filter-docs passes with no drift
  • make build succeeds
  • make test passes (82 tests)
  • make lint passes (clippy + fmt)

The migration from the praxis monorepo deleted filter_docs.rs and its
xtask wiring. Restore and adapt the doc generator for the new two-crate
layout (apis + filters), flatten doc output to docs/filters/{name}.md,
scan praxis core's payload_processing dir so OnInvalidBehavior expands,
and remove the stale json_rpc.md (filter moved to praxis core).

Signed-off-by: Sébastien Han <seb@redhat.com>
@leseb leseb requested review from a team and alexsnaps July 2, 2026 08:46
@leseb leseb requested a review from shaneutt as a code owner July 2, 2026 08:46
@praxis-bot-app

praxis-bot-app Bot commented Jul 2, 2026

Copy link
Copy Markdown

PR too large: 2434 lines added (limit: 750, excludes Cargo files, tests, docs, examples, and benchmarks). Please split into smaller PRs. Add skip/pr-conventions label to override.

@praxis-bot praxis-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

praxis-bot review: fix(xtask): restore filter doc generation for AI repo

Overall: Solid restoration of the filter doc generation xtask adapted for the two-crate AI layout. The core syn parsing, rendering, and lint pipeline are well-structured with good test coverage. A few items below.

Severity Count Summary
Medium 3 Convention violation, missing test coverage, hardcoded special case

Non-inline findings

None -- all findings are inline.

Comment thread xtask/src/filter_docs.rs
Comment thread xtask/src/filter_docs.rs
Comment thread xtask/src/filter_docs.rs
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.

3 participants