[GPCAPIM-304] Update repo documentation#106
Open
davidhamill1-nhs wants to merge 10 commits intomainfrom
Open
Conversation
davidhamill1-nhs
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation refresh to better reflect the repository’s current structure, tooling, and delivery approach at the end of the Steel Thread phase.
Changes:
- Expanded/updated top-level and component README documentation (architecture, repo layout, CI/CD, testing, infrastructure, scripts, Proxygen, Bruno).
- Added new component-level READMEs for
scripts/andinfrastructure/. - Updated Vale accepted vocabulary to reduce false positives on repo-specific terminology.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/config/vale/styles/config/vocabularies/words/accept.txt | Adds additional accepted terms/regexes for Vale documentation linting. |
| scripts/README.md | New overview of shared CI/CD and local development scripts and make includes. |
| proxygen/README.md | Rewrites Proxygen docs with clearer structure, config inputs, and CI/CD usage. |
| infrastructure/README.md | New overview of Terraform environments and Docker images used for AWS deployments. |
| gateway-api/README.md | Updates testing guidance, project structure, and dependency documentation for the Gateway API module. |
| bruno/README.md | Adds directory structure and clarifies environment setup for manual API testing collections. |
| README.md | Major rewrite: architecture overview, tech stack, repo structure, setup/usage/testing/CI/CD guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
Deployment Complete
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Update the repository's documentation.
Context
Given we are at the end of Steel Thread, a number of documents need to be updated to better reflect the current behaviours and technologies.
Type of changes
Checklist
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.