add guidance to hard code local plan doc

[pooleycodes]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Our long term solution is to better figure out working with the new specification. However, while we progress towards that the local hard coded local plan specification used within this repo has no guidance, this addresses this, as approved by content designers and a image to better show the biggest misunderstood issue we get: missing associated entity.

Related Tickets & Documents

• Ticket Link Explain missing associated entity better config#2757
• Related Issue #
• Closes #

QA Instructions, Screenshots, Recordings

Load a local plan dataset dataset with issues to review the guidance that shows.

A plan timetable dataset with missing associated entity would should the image, such as: https://provide.development.planning.data.gov.uk/organisations/local-authority%3ASHR/plan-timetable/missing%20associated%20entity/plan

As seen here:

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above. Please refer to the Digital Land Testing Guidance for more information.

• Yes
• No, and this is why: Docs Change
• I need help with writing tests

[optional] Are there any post deployment tasks we need to perform?

Removing this local hard coded local plan json and pull from the specification.

[optional] Are there any dependencies on other PRs or Work?

No

Summary by CodeRabbit

• Documentation

  • Expanded guidance for planning datasets, including references, plan types, dates, authorities, documentation links, housing requirements, records and timetable details.
  • Added further validation guidance for plan names, document links and related references.

• Bug Fixes

  • Improved responsive behaviour for images displayed in inset content, ensuring they fit their container while maintaining the correct aspect ratio.

[coderabbitai]

Warning

Review limit reached

@pooleycodes, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 27 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e433acb9-8e02-4d9e-b493-97e622e6248e

📥 Commits

Reviewing files that changed from the base of the PR and between 96ad399 and fccb96c.

📒 Files selected for processing (2)

• src/assets/scss/index.scss
• src/views/includes/_issue-guidance.html

Walkthrough

The plan fallback configuration now provides detailed field guidance and timetable references. Inset text images now scale to their container while preserving their aspect ratio.

Changes

Plan fallback guidance

Layer / File(s)	Summary
Plan fields and timetable reference config/plan-fallback.json	Local, supplementary, minerals, and waste plan fields now include detailed guidance. Timetable plan values must match the corresponding plan reference.

Inset image styling

Layer / File(s)	Summary
Responsive inset images src/assets/scss/index.scss	Images inside .govuk-inset-text now use a maximum width of 100% and automatic height.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related issues

• Add guidance and submission warnings for conditional local-plan fields #1241: Adds related guidance for local-plan conditional fields, including minerals and waste authorities and document counts.

Possibly related PRs

• digital-land/submit#1170: Introduced the config/plan-fallback.json configuration expanded by this change.

Suggested reviewers: gibahjoe

Poem

A rabbit checks each plan field with care,
Timetables match references there.
Inset images fit the view,
With width and height behaving true.
Hop, hop—the guidance is clear!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding guidance to the hard-coded local plan documentation.
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.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Fix failing CI checks

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 2757-explain-missing-associated-entity-better

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	71.16%	2559 / 3596
🔵	Statements	70.37%	2701 / 3838
🔵	Functions	64.48%	512 / 794
🔵	Branches	64.21%	1267 / 1973

File Coverage

No changed files found.

Generated in workflow #1569 for commit fccb96c by the Vitest Coverage Report Action

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@config/plan-fallback.json`:
- Around line 178-180: Update the guidance for
minerals-and-waste-planning-authorities at config/plan-fallback.json lines
178-180 and 243-245 by removing “or supplementary plan” from both occurrences,
leaving the remaining wording unchanged.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b79dc161-b692-47a6-ab26-3b4744808616

📥 Commits

Reviewing files that changed from the base of the PR and between 9cc342f and 96ad399.

⛔ Files ignored due to path filters (4)

• src/assets/static/images/plan-timetable-plan-relationship.svg is excluded by !**/*.svg
• src/content/allRowsIssueMessages.csv is excluded by !**/*.csv
• src/content/entityIssueMessages.csv is excluded by !**/*.csv
• src/content/fieldIssueMessages.csv is excluded by !**/*.csv

📒 Files selected for processing (2)

• config/plan-fallback.json
• src/assets/scss/index.scss

[jpherr]

👍