Skip to content

Commit 46446ba

Browse files
authored
refactor: restructure documentation (#283)
1 parent 661873b commit 46446ba

File tree

10 files changed

+9
-9
lines changed

10 files changed

+9
-9
lines changed

_typos.toml renamed to .typos.toml

File renamed without changes.

docs/development/guides/sequence_diagrams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Sequence diagrams can be used to convey message exchanges at different levels of
1717

1818
<figure markdown>
1919
![Import elements of a sequence diagram](images/sequence_diagram_elements.png)
20-
<figcaption>A sample sequence diagram with some import elements (<a href="https://mattsch.com/research/publications/#paper-7">Source</a>)</figcaption>
20+
<figcaption>A sample sequence diagram with some import elements (<a href="https://mattsch.com/research/#paper-1">Source</a>)</figcaption>
2121
</figure>
2222

2323
A detailed overview of all the elements can be found on [uml-diagrams.org](https://www.uml-diagrams.org/sequence-diagrams.html).
File renamed without changes.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ The following is a high-level overview of each section:
3131
1. [User Guide](user/index.md) (coming soon): instructions on navigating and configuring the Opal system as an end-user or administrator.
3232
1. [Contribute](development/index.md): everything you need to know as a developer to contribute to Opal's open-source development:
3333
- [Architecture](development/architecture/index.md)
34-
- [Setting up a local development environment](development/setup.md)
35-
1. [Deploy](deploy/index.md) (coming soon): how to deploy the Opal system in an environment
34+
- [Setting up a local development environment](development/local-dev-setup.md)
35+
1. [Install](install/index.md) (coming soon): how to deploy the Opal system in an environment
3636

3737
## Try it Yourself
3838

docs/deploy/index.md renamed to docs/install/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The user applications are deployed and maintained by the Opal Health Informatics
1313

1414
### Deployment diagram
1515

16-
```plantuml source="docs/deploy/diagrams/deployment_diagram_pie.puml"
16+
```plantuml source="docs/install/diagrams/deployment_diagram_pie.puml"
1717
```
1818

1919
Relationships between components on the same host are left out for brevity (except those making use of third-party components).
@@ -22,5 +22,5 @@ Relationships between components on the same host are left out for brevity (exce
2222

2323
### Deployment diagram
2424

25-
```plantuml source="docs/deploy/diagrams/deployment_diagram_user.puml"
25+
```plantuml source="docs/install/diagrams/deployment_diagram_user.puml"
2626
```
File renamed without changes.

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ nav:
2929
- development/architecture/migration.md
3030
- Registration Process: development/architecture/registration.md
3131
- development/architecture/checkin_process.md
32-
- development/setup.md
32+
- Set up a Local Development Environment: development/local-dev-setup.md
3333
- Best Practices:
3434
- Overview: development/best_practices/best_practices.md
3535
- Code Review: development/best_practices/code_review.md
@@ -41,9 +41,9 @@ nav:
4141
- JavaScript: development/guides/javascript.md
4242
- Sequence Diagrams: development/guides/sequence_diagrams.md
4343
- Generate Self Signed Certificates: development/guides/self_signed_certificates.md
44-
- Deploy:
45-
- Deploying The Opal Solution: deploy/index.md
46-
- Hospital Integration: deploy/integration.md
44+
- Install:
45+
- Deploying the Opal Solution: install/index.md
46+
- Hospital Integration: install/integration.md
4747

4848
# Configuration
4949
theme:

0 commit comments

Comments
 (0)