Repository navigation
Add twenty planning and validation docs pages - #2386
Open
vahid-ahmadi wants to merge 1 commit into
Open
vahid-ahmadi wants to merge 1 commit into
vahid-ahmadi wants to merge 1 commit into
Conversation
juaristi22
reviewed
Oct 15, 2026
juaristi22
left a comment
Collaborator
There was a problem hiding this comment.
Reviewed d50ee85a9664791d6c617135fed999418762f6a9 and all 20 consolidated pages. I found no blocking model defect, but three plans need technical corrections before they guide implementation:
docs/book/assumptions/takeup-analysis-plan.md:95–97: restrict the numerator to eligible units too:sum(would_claim_X * eligible_X * weight) / sum(eligible_X * weight). Willingness-to-claim flags can be true for ineligible units; one eligible unit and two willing units currently gives a documented rate of 200%. Define the zero-denominator case as well.docs/book/policy/future-date-announcements.md:67–71: restoring 20% on the reversal announcement date does not cancel an existing future 19% row. An executed check through fiscal-year conversion leaves 2023 at 19%. Remove or replace the cancelled row at its original effective date, retaining the announcement history in references/version control.docs/book/programs/gov/dwp/bereavement-support-plan.md:72–84: a flag for bereavement within the previous 18 months can remain true across consecutive annual periods, so the proposed formula can award the initial lump sum twice. Use a payment/claim-year flag or event date for the single initial payment, and reserve the 18-month information for instalments.
Minor: docs/book/programs/gov/dwp/pip-points-plan.md:163 needs the closing ) on the DWP statistics link.
Validation: all 24 well-formed local links resolve; all six Python blocks parse; the dated-row diagnostic ran; 21 cited/primary sources checked. Captured documentation CI passes. I did not rerun the full documentation build or historical private-dataset benchmarks locally. The 20 older docs PRs can continue to be handled as superseded by this bundle.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Combines 20 docs-only PRs into one, so main gets one release instead of twenty (each merge that adds a changelog fragment triggers a version bump and a PyPI release).
Each page was re-checked against current main today and corrected where it had gone stale. The fixes are on each original PR branch; this branch takes their final files unchanged. The diff touches only
docs/book/pages andchangelog.d/*.added.mdfragments, with no code, parameters or tests.programs/gov/hmrc/firm-vat.mdprograms/gov/cms/child-maintenance.mdassumptions/mp30k-uk-switch-plan.mdpolicy/indirect-tax-effects-plan.mdassumptions/non-uk-benefit-receipt-plan.mdprograms/gov/hmrc/pension-tax-relief.mdprograms/gov/hmrc/pensions-comparison-stbm.mdassumptions/uk-pipeline-alignment-plan.mdvalidation/child-poverty-tcl.mdprograms/gov/dwp/pip-points-plan.mdprograms/gov/dfe/regional-childcare-plan.mdpolicy/future-date-announcements.mdassumptions/takeup-analysis-plan.mdvalidation/policyengine-py-household-impact.mdvalidation/ubuntu-vs-macos.mdassumptions/capital-gains-distribution-plan.mdvalidation/reform-impacts-dashboard-plan.mdprograms/gov/ofgem/warm-home-discount-plan.mdprograms/gov/dwp/cold-weather-payment-plan.mdprograms/gov/dwp/bereavement-support-plan.mdThe linked issues stay open: these pages are plans and diagnoses, not the implementations.
Checks:
ruff format --check .(0.17.0) is clean, including the Python blocks in the pages.towncrier build --draftpicks up all 20 fragments.myst.ymlentries are needed, because the docs build picks pages up by folder pattern.axiom: n/a: documentation only, no rules or parameters change.
🤖 Generated with Claude Code