feat (#1)

alpenlabs · Sep 30, 2024 · a2c4e70 · a2c4e70
2 parents 60c212f + 87b240e
commit a2c4e70
Show file tree

Hide file tree

Showing 18 changed files with 31 additions and 181 deletions.
diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg
diff --git a/docs/bridge/cli.md b/docs/bridge/cli.md
diff --git a/docs/build-strata/deploying-programs.md b/docs/build-strata/deploying-programs.md
diff --git a/docs/build-strata/developer-resources.md b/docs/build-strata/developer-resources.md
diff --git a/docs/build-strata/troubleshooting.md b/docs/build-strata/troubleshooting.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/research/snarknado.md b/docs/research/snarknado.md
diff --git a/docs/run-strata/connecting-wallet.md b/docs/run-strata/connecting-wallet.md
diff --git a/docs/run-strata/hardware.md b/docs/run-strata/hardware.md
diff --git a/docs/run-strata/operator-guide.md b/docs/run-strata/operator-guide.md
diff --git a/docs/security.md b/docs/security.md
diff --git a/docs/security.txt b/docs/security.txt
@@ -0,0 +1,3 @@
+Contact: https://github.com/alpenlabs/strata/issues
+Expires: 2026-01-01T04:59:00.000Z
+Preferred-Languages: en
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -1,3 +1,12 @@
+:root {
+  --md-accent-fg-color: #bc512f;
+  --md-accent-fg-color--light: #bc512f;
+  --md-accent-fg-color--dark: #bc512f;
+  --md-accent-bg-color: #bc512f;
+  --md-accent-bg-color--light: #bc512f;
+  --md-accent-bg-color--dark: #bc512f;
+}
+
 .red {
   color: red;
 }

diff --git a/docs/build-strata/comparing-ethereum.md → docs/technical/comparing-ethereum.md b/docs/build-strata/comparing-ethereum.md → docs/technical/comparing-ethereum.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,35 +1,32 @@
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
-site_name: Alpen Labs Documentation
-site_url: https://alpenlabs.github.io/docs/
-repo_name: alpenlabs/docs
-repo_url: https://github.com/alpenlabs/docs
-copyright: Copyright &copy; 2024 Alpen Labs, Inc.
+site_name: Strata Documentation
+site_url: https://docs.stratabtc.org
+repo_url: https://github.com/alpenlabs/strata
 plugins:
   - search
 theme:
   name: material
-  logo: assets/logo.svg
+  logo: assets/logo.png
   icon:
     repo: fontawesome/brands/github
-  favicon: assets/logo.svg
+  favicon: assets/favicon.png
   palette:
     - scheme: default
-      primary: indigo
-      accent: indigo
+      primary: white
+      accent: custom
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
     - scheme: slate
-      primary: indigo
-      accent: indigo
+      primary: black
+      accent: custom
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
   font:
-    text: Roboto
+    text: Inter
     code: Roboto Mono
   features:
-    - navigation.tabs
     - navigation.instant
     - navigation.footer
     - search.suggest
@@ -39,19 +36,12 @@ theme:
     - content.code.copy
     - content.code.annotate
 extra:
-  homepage: https://alpenlabs.io
+  homepage: https://stratabtc.org
   generator: false
-  social:
-    - icon: fontawesome/solid/globe
-      link: https://alpenlabs.io
-    - icon: fontawesome/brands/twitter
-      link: https://x.com/alpenlabs
-    - icon: fontawesome/brands/github
-      link: https://github.com/alpenlabs
-    - icon: fontawesome/solid/paper-plane
-      link: mailto:contact@alpenlabs.io
 markdown_extensions:
   - tables
+  - toc:
+      permalink: true
   - attr_list
   - md_in_html
   - footnotes
@@ -82,27 +72,16 @@ extra_css:
 
 nav:
   - Introduction to Strata: index.md
-  - Welcome:
-      - Getting Started: getting-started.md
-      - Acknowledgements: acknowledgements.md
-  - Build Strata Apps:
-      - Developing Strata Programs: build-strata/deploying-programs.md
-      - Comparing Strata and Ethereum: build-strata/comparing-ethereum.md
-      - Developer Resources: build-strata/developer-resources.md
-      - Troubleshooting: build-strata/troubleshooting.md
-  - Run a Strata Node:
-      - Hardware Requirements: run-strata/hardware.md
-      - Operator Guide: run-strata/operator-guide.md
-      - Connecting you Wallet: run-strata/connecting-wallet.md
-  - Bridge to Strata:
-      - Bridge CLI: bridge/cli.md
   - How Strata Works:
       - Specifications: technical/specs.md
       - System Architecture: technical/architecture.md
       - Transaction Lifecycle: technical/transaction-lifecycle.md
       - Transaction Fees: technical/transaction-fees.md
       - Bitcoin Bridge: technical/bitcoin-bridge.md
       - Node Types: technical/node-types.md
-  - Research:
-      - SNARKnado-based bridge: research/snarknado.md
-  - Security: security.md
+      - Comparing Strata and Ethereum: technical/comparing-ethereum.md
+  - Community:
+      - Website: https://stratabtc.org
+      - GitHub: https://github.com/alpenlabs/strata
+      - Telegram: https://t.me/Strata_Community
+      - Twitter: https://twitter.com/Strata_BTC