Document the expanded interview metadata block

[Copilot]

Updates the "Understanding the YAML code" documentation to reflect the current expanded metadata block format used in AssemblyLine interviews, replacing the deprecated interview_metadata approach.

Changes Made

Replaced deprecated interview_metadata section with comprehensive documentation of the expanded metadata block format that includes:

• Comprehensive field reference: Documents 25+ metadata fields organized into 5 logical categories:

  • Basic information fields (title, description, can_I_use_this_form, before_you_start)
  • Technical and administrative fields (maturity, estimated_completion_minutes, languages, review_date)
  • Help and reference fields (help_page_url, original_form, form_titles)
  • Classification and organization (LIST_topics, jurisdiction, fees)
  • Maintenance and updates (update_notes)

• Modern metadata block example: Shows the current YAML structure with practical field values

• Clear deprecation notice: Informs developers that interview_metadata variable is deprecated

• Updated code references: Fixed interview order section to show current allowed_courts usage

Before vs After

Before: Documentation showed outdated interview_metadata code block approach:

mandatory: True
code: |
  interview_metadata['form_name'].update({
    "title": "Form Title",
    # ... other fields in code block
  })

After: Documentation shows current expanded metadata block:

metadata:
  title: |
    Form Title
  description: |
    Detailed description of what this interview does
  can_I_use_this_form: |
    Help text for users to determine if this is the right form
  maturity: production
  estimated_completion_minutes: 15
  # ... 20+ additional documented fields

This update ensures developers implement the correct metadata format that aligns with the expanded metadata support introduced in Court Forms Online.

Fixes #470.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.