Skip to content

CCM-13475: Update readme#176

Merged
tdroza-nhs merged 5 commits intomainfrom
feature/CCM-13475-update-readme
Jan 12, 2026
Merged

CCM-13475: Update readme#176
tdroza-nhs merged 5 commits intomainfrom
feature/CCM-13475-update-readme

Conversation

@tdroza-nhs
Copy link
Copy Markdown
Contributor

Description

The main change is to regenerate the README which has links to event schemas and example events. This automatic regeneration is currently broken and I've hacked the script locally to make it work for me but need to talk it through with Ross before commiting a change that will work both locally and in the pipeline. For now I'm just pushing and updated version of the locally generated README.

Some other minor changes to diagrams, mostly to add clarity to the virus scanning flow.

Context

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming
  • If I have used the 'skip-trivy-package' label I have done so responsibly and in the knowledge that this is being fixed as part of a separate ticket/PR.

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@tdroza-nhs tdroza-nhs requested a review from a team as a code owner January 9, 2026 16:46
@tdroza-nhs tdroza-nhs merged commit 8d297c4 into main Jan 12, 2026
90 of 91 checks passed
@tdroza-nhs tdroza-nhs deleted the feature/CCM-13475-update-readme branch January 12, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants