Skip to content

Commit 6e765a3

Browse files
committed
CCM-11207: review comments: spelling and repo changes
1 parent c07c8da commit 6e765a3

File tree

6 files changed

+9
-23
lines changed

6 files changed

+9
-23
lines changed

docs/_config.yml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ url: "https://nhsdigital.github.io" # the base hostname & protocol for your site
2828
collections_dir: collections
2929

3030
collections:
31-
repos:
32-
output: true
33-
sort_by: order
3431
consumers:
3532
output: true
3633
sort_by: order
@@ -44,17 +41,6 @@ just_the_docs:
4441
name: API Consumers
4542
developers:
4643
name: API Developers
47-
repos:
48-
name: Notify Repositories
49-
# Exclude the collection from the navigation
50-
# Supports true or false (default)
51-
nav_exclude: false
52-
# Fold the collection in the navigation
53-
# Supports true or false (default)
54-
nav_fold: false # note: this option is new in v0.4
55-
# Exclude the collection from the search
56-
# Supports true or false (default)
57-
search_exclude: false
5844

5945
defaults:
6046
- scope:

docs/collections/_consumers/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ A sandbox environment is available to aid in discovery and development of your i
5252

5353
It will provide limited, fixed responses and does not require authentication to use.
5454

55-
Their are two ways to access the sandbox:
55+
There are two ways to access the sandbox:
5656

5757
- The public sandbox [https://sandbox.api.service.nhs.uk/notify-supplier](https://sandbox.api.service.nhs.uk/notify-supplier)
5858
- Local Build

docs/collections/_developers/architecture-design/phase1-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ has_toc: false
66
parent: Architecture & Design
77
---
88

9-
The phase 1 design looks to implement the core API + Backend architecture and the event infrastructure for receiving letter requests and issuing updates.
9+
The diagram below illustrates the phase 1 design of the Supplier API. This meets the MVP for the API functionality for receiving, issuing, and updating letters and other print media.
1010

11-
The below diagram implements the implemented components. The logic for letter allocation outside the Supplier API context is not expanded upon:
11+
This does not include the necessary changes to NHS Notify to allocate letters.
1212

1313
{% drawio path="assets/diagrams/phase1-design.drawio" page_number=0 height=800 %}

docs/collections/_developers/architecture-design/target-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The target architecture for the NHS Notify Supplier API is represented below:
1212

1313
Letters are produced from external contexts, the primary use case being NHS Notify Core. These are received via event, consumed, and placed into the DynamoDB store as appropriate.
1414

15-
The API is accessed by an API Management Platform proxy that targets and AWS backend through API Gateway.
15+
The API is accessed by an API Management Platform proxy that targets an AWS backend through API Gateway.
1616

1717
Lambdas act as request handlers, manipulating Dynamo DB data stores and issuing responses back to the proxy.
1818

docs/collections/_developers/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The Supplier API repository contains the following:
1414

1515
- [.devcontainer](/.devcontainer) - A devcontainer that should be used for work on this repository that maintains developer dependencies
1616
- [.github](/.github) - GitHub workflows and actions for CI/CD
17-
- [docs](/docs) - This documentation; generated and publish on pre-release (PR merge to main)
17+
- [docs](/docs) - This documentation; generated and published on pre-release (PR merge to main)
1818
- [infrastructure](/infrastructure) - Infrastructure as code maintained in Terraform
19-
- [internal](/internal) - Internal packacges and libraries, e.g. database repositories
19+
- [internal](/internal) - Internal packages and libraries, e.g. database repositories
2020
- [lambdas](/lambdas) - Implementation of lambda handler functions
2121
- [postman](/postman) - Postman collection(s) which can be imported to assist in API development and testing
2222
- [sandbox](/sandbox) - Sandbox logic; [!NOTE] The sandbox specification is built from the core specification and should not be directly modified
@@ -26,7 +26,7 @@ The Supplier API repository contains the following:
2626
- [src](/src) - Non lambda implementation
2727
- [tests](/tests) - Higher level component and E2E test suites
2828

29-
The API dependencies are manages through [NPM Workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces/)
29+
The API dependencies are managed through [NPM Workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces/)
3030

3131
## Setup
3232

@@ -42,7 +42,7 @@ code .
4242

4343
#### devcontainer
4444

45-
You should use the devcontainer for thsi repository to satisy pre-requisites and configuration.
45+
You should use the devcontainer for this repository to satisy pre-requisites and configuration.
4646
You can open this using devcontainer plugins or GitHub workspaces
4747
By default it will run the necessary `make config`, `postcreatecommand.sh`, and `poststartcommand.sh`
4848

docs/pages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Released versions of the specification can be found within [latest releases](htt
8484

8585
## API Consumers
8686

87-
If you wish to integrated with the Supplier API refer to the [API Consumer](/consumers) pages and
87+
If you wish to integrate with the Supplier API refer to the [API Consumer](/consumers) pages and
8888
[Getting Started as an API Consumer](/consumers/getting-started)
8989

9090
You may also find it helpful to refer to the [Specification](/specification)

0 commit comments

Comments
 (0)