Skip to content
This repository has been archived by the owner on Feb 7, 2023. It is now read-only.

Commit

Permalink
Merge pull request #133 from swarmion/docs/install
Browse files Browse the repository at this point in the history
docs: fix broken link to contracts
  • Loading branch information
fargito authored Mar 25, 2022
2 parents 570c072 + 61b45b4 commit e7367f3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/monorepo-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Nx:

- Filter changes, run commands

Yarn workpaces:
Yarn workspaces:

- Handle dependencies anywhere in the repository

Expand All @@ -114,5 +114,5 @@ This repository defines two main types of _internal modules_.

- Deployed modules (Serverless stacks): their purpose is to be deployed and serve our application logic, provision the resources, etc. They are called the **services**;
- Packaged modules (contracts and packages): their purpose is to be **built** (or **packaged**) and embedded into the code of a deployed service:
- **contracts**: provide a binding contract between deployed services, that can be checked at compile time via the static type-checking provided by Typescript or at run time using JSONSchema. For more details on contracts, see the [contracts documentation](./contracts.md);
- **contracts**: provide a binding contract between deployed services, that can be checked at compile time via the static type-checking provided by Typescript or at run time using JSONSchema. For more details on contracts, see the [contracts documentation](https://github.com/swarmion/swarmion/tree/main/packages/serverless-contracts);
- **packages**: aim to reduce the code duplication between the services by providing shared helper functions. These packages must not become too big in order for them to remain usable and must be well documented.

0 comments on commit e7367f3

Please sign in to comment.