Provide content updates

[Ben-Hodgkiss]

Description

Updated content around providing data to promote the Check tool prior to submitting.

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

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

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

• Yes
• No, and this is why: Content change only
• I need help with writing tests

QA sign off

• Code has been checked and approved
• Design has been checked and approved
• Product and business logic has been checked and proved

Summary by CodeRabbit

• New Features

  • Updated instructions for submitting organisation data, now providing a single, clear process with a direct link to the endpoint submission form.
  • Added a reminder on the LPA details page to check your data before submission, including a helpful link for guidance.

• Style

  • Streamlined and unified the presentation of submission instructions for improved clarity.

[coderabbitai]

Walkthrough

The changes unify and simplify submission instructions in two HTML templates by removing a feature flag conditional and presenting consistent guidance to users. Both templates now encourage users to check their data before submission and provide a standardised set of instructions and links for submitting information.

Changes

File(s)	Change Summary
src/views/organisations/get-started.html	Removed feature flag conditional; merged bifurcated instructions into a single, unified message and link.
src/views/submit/lpa-details.html	Added a new paragraph prompting users to check their data before submission, including a relevant link.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GetStartedPage
    participant SubmissionForm

    User->>GetStartedPage: Visit get-started.html
    GetStartedPage-->>User: Show unified instructions and endpoint submission link

    User->>SubmissionForm: Follow link to endpoint submission form
    SubmissionForm-->>User: Provide submission interface

Loading

Estimated code review effort

2 (10–30 minutes)

Possibly related PRs

• Update get-started.html #1068: Updates terminology from "submit" to "provide" without changing logic, related to messaging simplification but not overlapping in control flow.

Suggested reviewers

• rosado

Poem

A hop and a skip, the forms are now clear,
No more toggles or branching to fear.
"Check your data!" the templates now say,
Unified guidance to help on your way.
With one simple link, submission’s a breeze—
Even a rabbit could do it with ease! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6fd9a8c and 0521526.

📒 Files selected for processing (1)

• src/views/organisations/get-started.html (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/views/organisations/get-started.html

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: run-tests / test

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	66.38%	5969 / 8992
🔵	Statements	66.38%	5969 / 8992
🔵	Functions	64.54%	253 / 392
🔵	Branches	80.56%	771 / 957

File Coverage

No changed files found.

Generated in workflow #1121 for commit 0521526 by the Vitest Coverage Report Action

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/views/submit/lpa-details.html (1)

52-54: Consider an absolute path for the “check your data” link

The href check/upload-method is relative to the current URL, which may break if this template is rendered from nested routes. Using an absolute path (e.g. /check/upload-method) or an appropriate Nunjucks filter (as used elsewhere) makes the link robust.

-Always <a href="check/upload-method" class="govuk-link">check your data before you provide it</a>.
+Always <a href="/check/upload-method" class="govuk-link">check your data before you provide it</a>.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4cfc10d and 478985f.

📒 Files selected for processing (2)

• src/views/organisations/get-started.html (1 hunks)
• src/views/submit/lpa-details.html (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

src/views/submit/lpa-details.html (1)

Learnt from: GeorgeGoodall-GovUk
PR: #593
File: src/content/statusPage.js:6-9
Timestamp: 2024-10-28T15:07:21.647Z
Learning: The message 'Do not close this page' in export const messageTexts within src/content/statusPage.js is a design decision and should remain unchanged.

src/views/organisations/get-started.html (1)

Learnt from: GeorgeGoodall-GovUk
PR: #593
File: src/content/statusPage.js:6-9
Timestamp: 2024-10-28T15:07:21.647Z
Learning: The message 'Do not close this page' in export const messageTexts within src/content/statusPage.js is a design decision and should remain unchanged.

🪛 GitHub Actions: Unit test coverage report

src/views/organisations/get-started.html

[error] 211-211: Template render error: unknown block tag: endif

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: run-tests / test