Add comprehensive documentation for impounded addresses feature #535
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.
This PR adds user-facing documentation for the impounded addresses feature that was implemented in docassemble-AssemblyLine PR #760.
While the API documentation was automatically generated and already included the new parameters and attributes, there was no user-facing documentation explaining what impounded addresses are, when to use them, or how to implement them in interviews.
What's Added
The new documentation section in
/docs/style_guide/question_library/addresses.mdincludes:Introduction: Clear explanation that impounded addresses are addresses that should be hidden or redacted on certain documents for safety or privacy reasons, commonly needed in domestic violence cases, restraining orders, or other sensitive legal situations.
When to use: Specific guidance on appropriate use cases:
Implementation examples: Both Assembly Line and vanilla Docassemble approaches for:
ask_if_impounded=Trueshow_impounded=TrueparameterComplete reference: List of all address display methods that support the
show_impoundedparameter, custom template guidance, and a working complete example.Important warnings: About
normalized_address()not respecting impounded status.The approach was surgical and focused - adding one comprehensive section to existing documentation rather than creating new files or making extensive changes.
Fixes #436.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.