docs: Migrate Sapphire docs to sapphire-paratime repo

oasisprotocol · Nov 27, 2023 · f2e2eee · f2e2eee
1 parent 0ea0562
commit f2e2eee
Show file tree

Hide file tree

Showing 22 changed files with 25 additions and 1,864 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -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
diff --git a/README.md b/README.md
@@ -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

diff --git a/docs/dapp/images/sapphire/gasless-gsn-flow.jpg b/docs/dapp/images/sapphire/gasless-gsn-flow.jpg
diff --git a/docs/dapp/images/sapphire/gasless-on-chain-signer.svg b/docs/dapp/images/sapphire/gasless-on-chain-signer.svg
diff --git a/docs/dapp/images/sapphire/hardhat-boilerplate-frontend1.png b/docs/dapp/images/sapphire/hardhat-boilerplate-frontend1.png
diff --git a/docs/dapp/images/sapphire/hardhat-boilerplate-frontend2.png b/docs/dapp/images/sapphire/hardhat-boilerplate-frontend2.png
diff --git a/docs/dapp/images/sapphire/hardhat-boilerplate-frontend3.png b/docs/dapp/images/sapphire/hardhat-boilerplate-frontend3.png
diff --git a/docs/dapp/images/sapphire/sourcify1.png b/docs/dapp/images/sapphire/sourcify1.png
diff --git a/docs/dapp/images/sapphire/sourcify2.png b/docs/dapp/images/sapphire/sourcify2.png
diff --git a/docs/dapp/images/sapphire/sourcify3.png b/docs/dapp/images/sapphire/sourcify3.png
diff --git a/docs/dapp/sapphire/addresses.md b/docs/dapp/sapphire/addresses.md
diff --git a/docs/dapp/sapphire/addresses.md b/docs/dapp/sapphire/addresses.md
@@ -0,0 +1 @@
+../../../external/sapphire-paratime/docs/addresses.md
diff --git a/docs/dapp/sapphire/authentication.md b/docs/dapp/sapphire/authentication.md
diff --git a/docs/dapp/sapphire/authentication.md b/docs/dapp/sapphire/authentication.md
@@ -0,0 +1 @@
+../../../external/sapphire-paratime/docs/authentication.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../external/sapphire-paratime/docs/addresses.md