git clone [email protected]:criteo/addressable-network-proposals.git
cd addressable-network-proposals
git submodule init # This step will soon be removed- All main documents are located in /mvp-spec and use Markdown format (
*.md)- the content of these documents can be updated by contributors, except the parts surrounded by
<!--partial-begin ..-->and<!--partial-end-->: these sections should not be modified.
- the content of these documents can be updated by contributors, except the parts surrounded by
- These special sections in Markdown documents are used to automatically "inject" content that needs to be repeated in different documents.
We call these "partials".
- Partials are stored in /mvp-spec/partials and can be modified
- Mermaid diagrams (
*.mmd) are also stored in thispartialsdirectory and can be modified - For details about the usage of partials, see the README
- The model of data and messages is defined in /mvp-spec/json-schemas
- The associated documentation is generated in /mvp-spec/model
- For details about the generation of model documentation, see the README