Create and Maintain Check and Provide Service Technical Documentation

[gibahjoe]

Summary

Create high-level technical documentation for the Check and Provide service on the technical documentation website.

The documentation should explain the check and submit processes, how they relate to each other, and how the service fits into the wider Digital Land platform.

Description

Add a high-level overview of the Check and Provide service to the technical documentation website.

The content should be aimed at readers who need to understand what the service does and how its main processes work, without needing detailed knowledge of the codebase.

Add the Check and Provide page under the new top-level Code base navigation item.

The proposed navigation structure is:

Code base
├── Planning API / Digital Land
├── Check and Provide
├── Manage service
└── Other codebases

The Check and Provide documentation should cover:

• The purpose of the service.
• The difference between the check process and the submit process.
• The main user journeys handled by the service.
• How data enters the check process.
• What validation or checks are performed.
• What happens when checks pass or fail.
• How checked data moves into the submit process.
• How data is submitted or provided.
• The main inputs and outputs.
• The services, repositories, datasets and shared components it depends on.
• How the service interacts with Manage and the wider Digital Land platform.
• Links to the lower-level code documentation stored in the main repository.

The existing submit tutorial should be reviewed and moved, restructured or incorporated into the new Check and Provide section:

https://digital-land.github.io/technical-documentation/development/tutorials/submit-tutorial/

Existing documentation about working on the Submit service should also be reviewed and either incorporated into the new structure or linked from it where appropriate.

The page should remain high level and should not duplicate detailed implementation guidance from the repository documentation.

Charts or diagrams should be included where they improve understanding. These may include:

• A high-level check process flow.
• A high-level submit process flow.
• An end-to-end diagram showing how data moves from check to submit.
• A service interaction diagram showing how Check and Provide connects with Manage, Datasette and other Digital Land services.

The documentation should link to the relevant process-specific code documentation under the docs/ folder in the main Check and Provide repository.

Acceptance Criteria

• A Check and Provide page exists under the Code base section of the technical documentation website.
• The purpose and responsibilities of the service are clearly explained.
• The distinction between the check process and the submit process is clear.
• The main user journeys handled by the service are identified.
• The check process is explained at a high level.
• The submit process is explained at a high level.
• The expected outcomes for successful and failed checks are documented.
• The main inputs and outputs are documented.
• Key dependencies, supporting services, repositories and datasets are identified.
• The relationship between Check and Provide, Manage and the wider Digital Land platform is explained.
• At least one high-level chart or diagram is included where it improves understanding.
• The existing submit tutorial has been reviewed and moved, restructured, incorporated or linked appropriately.
• Existing Submit service documentation has been reviewed and reused where appropriate.
• Old links are updated or redirected where necessary.
• The page links to the relevant process-specific documentation in the main repository’s docs/ folder.
• Detailed code-level content is not duplicated unnecessarily.
• The content has been reviewed by the relevant service owner or subject-matter expert.
• The documentation is published successfully and all links work.