initial commit

eshaben · eshaben · commit 1d6c0a5f6851 · 2024-07-24T12:17:45.000-04:00
diff --git a/.CONTRIBUTING.md b/.CONTRIBUTING.md
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,17 @@
+[*.ts]
+indent_style=space
+indent_size=2
+max_line_length=80
+quote_type=single
+
+[*.js]
+indent_style=space
+indent_size=2
+max_line_length=80
+quote_type=single
+
+[*.json]
+indent_style=space
+indent_size=4
+max_line_length=80
+quote_type=single
diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md
@@ -0,0 +1,9 @@
+### Description
+
+Please explain the changes this PR addresses here.
+
+### Checklist
+
+- [ ] **Required** - I have added a label to this PR 🏷️
+- [ ] **Required** - I have run my changes through Grammarly
+- [ ] If pages have been moved, I have created redirects in the `wormhole-mkdocs` repo
diff --git a/.github/workflows/check-mkdocs-build.yml b/.github/workflows/check-mkdocs-build.yml
@@ -0,0 +1,43 @@
+name: CheckMkDocsBuild
+on:
+  # Trigger the workflow on a new pull request on main
+  pull_request_target:
+    branches:
+      - main
+
+jobs:
+  build-docs-site:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Allow to move dotfiles
+        run: |
+          # move also dotfile with *
+          shopt -s dotglob
+
+      - name: Clone Wormhole MKDocs
+        run: |
+          # clone mkdocs repo locally
+          git clone https://${{ secrets.REPO_SCOPED_TOKEN }}@github.com/papermoonio/wormhole-mkdocs.git
+
+      - name: Move wormhole-docs contents to mkdocs repository
+        run: |
+          mkdir wormhole-mkdocs/wormhole-docs
+          mv * wormhole-mkdocs/wormhole-docs &> /dev/null || echo "Error with mv expected due to recursively moving all contents into subfolder"
+
+      - name: Install pip requirements
+        run: |
+          cd wormhole-mkdocs
+          # upgrade pip
+          pip3 install --upgrade pip setuptools==65.7.0
+          # install dependencies quietly
+          pip3 install -r requirements.txt &> /dev/null && echo "Dependencies installed" || echo "Error while installing dependencies"
+
+      - name: Build mkdocs
+        run: |
+          cd wormhole-mkdocs
+          # change destination build folder in mkdocs YAML to local site/
+          sed -i 's/site_dir.*/site_dir: site/' mkdocs.yml
+          # build project
+          python3 -m mkdocs build
diff --git a/.pages b/.pages
@@ -0,0 +1,5 @@
+nav:
+ - index.md
+ - build
+ - learn
+ - tutorials
diff --git a/.snippets/code/example.js b/.snippets/code/example.js
@@ -0,0 +1 @@
+`INSERT_CODE_SNIPPETS`;
diff --git a/.snippets/text/example.md b/.snippets/text/example.md
@@ -0,0 +1 @@
+# INSERT_TEXT_SNIPPETS
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Documentation for Wormhole
+
+This repository contains documentation for Wormhole, an interoperability platform powering multichain apps and bridges. Here, you'll find both high-level and technical information for developers.
+
+## About This Site
+
+The content in this repository is displayed on the Wormhole documentation site, [docs.wormhole.com](https://docs.moonbeam.network/), and is generated using [mkdocs](https://www.mkdocs.org). The theme used is [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).
+
+## Contributing
+
+TODO
diff --git a/build/.pages b/build/.pages
@@ -0,0 +1,4 @@
+title: Build
+nav:
+ - index.md
+ - start-building
diff --git a/build/index.md b/build/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/build/start-building/.pages b/build/start-building/.pages
@@ -0,0 +1,4 @@
+title: Start Building
+nav:
+ - index.md
+ - 'Supported Networks': 'supported-networks.md'
diff --git a/build/start-building/index.md b/build/start-building/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/build/start-building/supported-networks.md b/build/start-building/supported-networks.md
diff --git a/index.md b/index.md
@@ -0,0 +1,10 @@
+---
+title: Home
+description: Explore Wormhole's comprehensive guides, tutorials, and resources to build secure multichain applications and enable seamless cross-chain communication.
+template: home.html
+hide:
+  - navigation
+  - feedback
+  - toc
+  - footer
+---
diff --git a/learn/.pages b/learn/.pages
@@ -0,0 +1,5 @@
+title: Learn
+nav:
+ - index.md
+ - 'Introduction to Wormhole': 'introduction.md'
+ - infrastructure
diff --git a/learn/index.md b/learn/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/learn/infrastructure/.pages b/learn/infrastructure/.pages
@@ -0,0 +1,4 @@
+title: Infrastructure Components
+nav:
+ - index.md
+ - 'VAAs': 'vaas.md'
diff --git a/learn/infrastructure/index.md b/learn/infrastructure/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/learn/infrastructure/vaas.md b/learn/infrastructure/vaas.md
diff --git a/learn/introduction.md b/learn/introduction.md
diff --git a/tutorials/.pages b/tutorials/.pages
@@ -0,0 +1,4 @@
+title: Tutorials
+nav:
+ - index.md
+ - messaging
diff --git a/tutorials/index.md b/tutorials/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/tutorials/messaging/.pages b/tutorials/messaging/.pages
@@ -0,0 +1,4 @@
+title: Messaging
+nav:
+ - index.md
+ - 'Create Cross-Chain Contracts': 'cross-chain-contracts.md'
diff --git a/tutorials/messaging/cross-chain-contracts.md b/tutorials/messaging/cross-chain-contracts.md
diff --git a/tutorials/messaging/index.md b/tutorials/messaging/index.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/variables.yml b/variables.yml
@@ -0,0 +1 @@
+example: INSERT_VARIABLES
