You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,8 +89,7 @@ sequenceDiagram
89
89
│ └── modules/ # Terraform modules
90
90
├── proxygen/ # API proxy deployment configuration
91
91
├── scripts/ # Build, test, and CI/CD scripts
92
-
├── bruno/ # Bruno API collection for manual testing
93
-
└── docs/ # Architecture decision records and guides
92
+
└── bruno/ # Bruno API collection for manual testing
94
93
```
95
94
96
95
For more detail on the test suites, see the [tests README](gateway-api/tests/README.md).
@@ -174,17 +173,15 @@ For detailed information about each test type, directory layout, and how to run
174
173
175
174
### Architecture Diagrams
176
175
177
-
Architecture diagrams follow the [C4 model](https://c4model.com/). Diagram source files are stored in [docs/diagrams/](docs/diagrams/) for version control and review. Diagrams can be created using [draw.io](https://app.diagrams.net/) or [Mermaid](https://github.com/mermaid-js/mermaid).
Architecture diagrams follow the [C4 model](https://c4model.com/) and can be created using [draw.io](https://app.diagrams.net/) or [Mermaid](https://github.com/mermaid-js/mermaid).
180
177
181
178
### Stubs
182
179
183
180
The `gateway-api/stubs/` directory contains stub implementations of the external services (PDS, SDS, GP Provider). These are used during local development and testing so that tests can run without connecting to live NHS services. Stubs are activated via environment variables.
184
181
185
182
### Architecture Decision Records
186
183
187
-
Design decisions are documented as Architecture Decision Records (ADRs) in the [docs/adr/](docs/adr/) directory.
184
+
Significant design decisions are documented as Architecture Decision Records (ADRs). The ADR format follows the [NHS England Repository Template](https://github.com/nhs-england-tools/repository-template) convention.
188
185
189
186
## CI/CD
190
187
@@ -207,7 +204,7 @@ Contributions are welcome. To get started:
207
204
3. Run `make githooks-config` to enable pre-commit hooks for secret scanning and formatting checks
208
205
4. Open a pull request with a clear description of the change
209
206
210
-
Design decisions and their rationale are captured in [Architecture Decision Records](docs/adr/).
207
+
Design decisions and their rationale are captured as Architecture Decision Records.
0 commit comments