Skip to content

Commit a63eb7c

Browse files
Remove tempalte docs directory, and move pertinent information in to READMEs
1 parent e11cf71 commit a63eb7c

33 files changed

Lines changed: 128 additions & 2691 deletions

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ sequenceDiagram
8989
│ └── modules/ # Terraform modules
9090
├── proxygen/ # API proxy deployment configuration
9191
├── 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
9493
```
9594

9695
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
174173

175174
### Architecture Diagrams
176175

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).
178-
179-
![Repository Template](./docs/diagrams/Repository_Template_GitHub_Generic.png)
176+
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).
180177

181178
### Stubs
182179

183180
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.
184181

185182
### Architecture Decision Records
186183

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.
188185

189186
## CI/CD
190187

@@ -207,7 +204,7 @@ Contributions are welcome. To get started:
207204
3. Run `make githooks-config` to enable pre-commit hooks for secret scanning and formatting checks
208205
4. Open a pull request with a clear description of the change
209206

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.
211208

212209
## Licence
213210

docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md

Lines changed: 0 additions & 148 deletions
This file was deleted.

docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md

Lines changed: 0 additions & 149 deletions
This file was deleted.

0 commit comments

Comments
 (0)