Skip to content

Commit

Permalink
Merge pull request #636 from oasisprotocol/matevz/docs/migrate-sapphi…
Browse files Browse the repository at this point in the history
…re-docs

docs: Migrate Sapphire docs to sapphire-paratime repo
  • Loading branch information
matevz authored Nov 27, 2023
2 parents 0ea0562 + e44ee08 commit dba6ae3
Show file tree
Hide file tree
Showing 28 changed files with 27 additions and 1,993 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@
[submodule "external/cli"]
path = external/cli
url = https://github.com/oasisprotocol/cli
[submodule "external/sapphire-paratime"]
path = external/sapphire-paratime
url = https://github.com/oasisprotocol/sapphire-paratime
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,23 +179,24 @@ number in the comment which added this redirection for future reference, if
major rewrite is to happen and the developers would need more context around
the redirection.

### Diagrams
### Images

There are three kinds of image assets currently used in the docs.
There are three kinds of image assets used in the docs.

1. Screenshots, photos, non-technical figures go into `images/` folder of the
respected top-level chapter.
1. Screenshots, photos, non-technical figures go into `images/` folder
on the part-level (i.e. `docs/dapp/images`). External repositories may use
own images in their respective folder.
2. [Mermaid](https://mermaid-js.github.io) diagrams (preferred tool for
sequence diagrams, flowcharts and other technical material) live in
`diagrams/` folder of the respected top-level chapter. Diagram sources
reside in the .mmd files. To generate .svg which can be used in the
`diagrams/` folder of the respective part or the external repository. Diagram
sources reside in the .mmd files. To generate .svg which can be used in the
markdown run `yarn diagrams`. Both .svg and .mmd files should be stored in
git. CI will check that they are always in sync.
3. Other diagrams which cannot be designed with Mermaid are drawn in
[diagrams.net](https://diagrams.net) and then stored locally inside
`images/` folder along other images. When exporting the diagram, don't
forget to tick the "Include a copy of my diagram" checkbox so that the
diagram source will be stored along in the .svg file so you will
diagram source will be stored along in the .svg file and you will
be able to edit it in the future.

## Vocabulary
Expand Down
63 changes: 0 additions & 63 deletions docs/dapp/diagrams/c10l-smart-contract-call.mmd

This file was deleted.

1 change: 0 additions & 1 deletion docs/dapp/diagrams/c10l-smart-contract-call.mmd.svg

This file was deleted.

63 changes: 0 additions & 63 deletions docs/dapp/diagrams/c10l-smart-contract-tx.mmd

This file was deleted.

1 change: 0 additions & 1 deletion docs/dapp/diagrams/c10l-smart-contract-tx.mmd.svg

This file was deleted.

Binary file removed docs/dapp/images/sapphire/gasless-gsn-flow.jpg
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/dapp/images/sapphire/gasless-on-chain-signer.svg

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/dapp/images/sapphire/sourcify1.png
Binary file not shown.
Binary file removed docs/dapp/images/sapphire/sourcify2.png
Binary file not shown.
Binary file removed docs/dapp/images/sapphire/sourcify3.png
Binary file not shown.
18 changes: 0 additions & 18 deletions docs/dapp/sapphire/addresses.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/dapp/sapphire/addresses.md
209 changes: 0 additions & 209 deletions docs/dapp/sapphire/authentication.md

This file was deleted.

Loading

0 comments on commit dba6ae3

Please sign in to comment.