refactor: docs copy from foundry template repo (#23)

reecepbcups · web-flow · commit eeae9273a56b · 2025-03-04T17:55:35.000-06:00
* docs refactoring

* re-add markdown files for vercel to deploy properly

* fix: imports

* fix: import lines for copytree

* migrate to direct links for images

* fix: script

* run from upstream main

* re-enable cron

* automated pr label

* feat: use only `docsignore`

* minor comment
diff --git a/.github/workflows/latest-docs.yml b/.github/workflows/latest-docs.yml
@@ -0,0 +1,56 @@
+name: Sync Latest Docs
+
+on:
+    workflow_dispatch:
+        inputs:
+          commit:
+            description: 'Commit SHA to sync from'
+            required: true
+            default: 'main'
+            type: string
+    schedule:
+      - cron: "0 12 */3 * *"  # noon every so often
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  BRANCH: "sync-${{ github.sha }}"
+
+jobs:
+  # This job just grabs the latest commits (if any) and creates a PR with the changes
+  # if there are no changes, no PR
+  # Another action will handle the PR verification for builds
+  file-sync:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v4
+
+            # https://github.com/orgs/community/discussions/55906#discussioncomment-5946239
+            # https://github.com/settings/personal-access-tokens/new
+            # To verify the PR, we must set a PAT token in the secrets
+        - name: Check for PAT
+          run: |
+            if [ -z "${{ secrets.GIT_WORKFLOW_PAT }}" ]; then
+                echo "Please set the GIT_WORKFLOW_PAT secret to support PR workflow runs on generate"
+                exit 1
+            fi
+
+        - name: grab latest documentation files
+          run: make latest-docs
+
+        # exits if there are no changes
+        - uses: peter-evans/create-pull-request@v7.0.5
+          with:
+            base: main
+            branch: ${{ env.BRANCH }}
+            title: "chore: update upstream docs"
+            commit-message: "chore: sync latest"
+            delete-branch: true
+            signoff: false
+            token: ${{ secrets.GIT_WORKFLOW_PAT }}
+            labels: |
+                automated pr
+            body: |
+                Syncing the latest file commits from upstream.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ package-lock.json
 .vercel
 next-env.d.ts
 .vscode
+
+# docs shallow git cloned repo
+dsource-*
diff --git a/Makefile b/Makefile
@@ -0,0 +1,12 @@
+## latest-docs: Pulls the latest docs from upstream | make latest-docs COMMIT=<COMMIT_SHA>
+.PHONY: latest-docs
+latest-docs:
+	@python3 ./scripts/sync_latest_docs.py $(COMMIT)
+
+.PHONY: help
+help: Makefile
+	@echo
+	@echo " Choose a command run in 'dev-portal'"
+	@echo
+	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
+	@echo
diff --git a/content/docs/benefits.mdx b/content/docs/benefits.mdx
@@ -4,7 +4,7 @@ title: WAVS benefits
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-<img alt="WAVS" src="/banners/benefits.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/banners/benefits.png" />
 
 >WAVS is a platform that makes building AVSs easier.
 
diff --git a/content/docs/guides/get-started.mdx b/content/docs/guides/get-started.mdx
@@ -4,7 +4,6 @@ title: Get Started
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 This guide walks you through how to set up your environment, deploy an example service, and run a task.
 
 ## Setup
diff --git a/content/docs/guides/operator.mdx b/content/docs/guides/operator.mdx
@@ -4,7 +4,6 @@ title: Run an operator (WIP)
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 ## Requirements
 
 Operators running WAVS will need the following minimum requirements:
diff --git a/content/docs/guides/query-from-a-component.mdx b/content/docs/guides/query-from-a-component.mdx
@@ -4,7 +4,6 @@ title: Query from a component (WIP)
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 ## Coming soon!
 
 This guide covers how to run a query in a service component.
diff --git a/content/docs/guides/tests.mdx b/content/docs/guides/tests.mdx
@@ -4,7 +4,6 @@ title: Testing a component
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 ## Build your component
 
 Use the following command to build your component:
diff --git a/content/docs/how-it-works.mdx b/content/docs/how-it-works.mdx
@@ -4,7 +4,7 @@ title: How it works
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-<img alt="WAVS" src="/banners/how.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/banners/how.png" />
 
 WAVS is a decentralized execution framework for AVSs (Autonomous Verifiable Services), enabling the results of off-chain computation to be brought verifiably on-chain. It provides a runtime for executing WASI-based service components, allowing developers to define event-driven off-chain workflows while inheriting Ethereum's security via EigenLayer restaking.
 
@@ -17,7 +17,7 @@ The WAVS platform comprises service components, operator networks, and on-chain
 
 Before diving into each part of a WAVS service individually, it's important to understand the basic execution flow of WAVS.
 
-<img alt="WAVS overview" src="/diagrams/flow.png" />
+<img alt="WAVS overview" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/diagrams/flow.png" />
 
 In this example, on-chain events can trigger service components, which are run off-chain by operators in the WASI AVS runtime. Results are then brought back on-chain, enabling the decentralized execution of off-chain services that are verifiable on-chain.
 
diff --git a/content/docs/index.mdx b/content/docs/index.mdx
@@ -5,7 +5,7 @@ import { HomeIcon, AppWindow, CircuitBoard, Layers, Microscope, Grid2x2, Chevron
 import { Callout } from 'fumadocs-ui/components/callout';
 import { DocsPage } from 'fumadocs-ui/page';
 
-<img alt="WAVS" src="/wavs.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/wavs.png" />
 
 Welcome to the WAVS Docs!
 
@@ -14,10 +14,10 @@ WAVS is a next-generation AVS platform that makes it easy to create, manage, and
 ## Get started
 
 <Cards>
-      <Card
+  <Card
     icon={<CircuitBoard />}
     href="/overview"
-    title="WAVS Overview" 
+    title="WAVS Overview"
     description="Learn about WAVS"
   />
   <Card
diff --git a/content/docs/overview.mdx b/content/docs/overview.mdx
@@ -5,7 +5,7 @@ import { HomeIcon, AppWindow, CircuitBoard, Layers, Microscope, Grid2x2, Chevron
 import { Callout } from 'fumadocs-ui/components/callout';
 import { DocsPage } from 'fumadocs-ui/page';
 
-<img alt="WAVS" src="/banners/intro.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/banners/intro.png" />
 
 ## What is WAVS?
 
@@ -43,7 +43,7 @@ This example will cover a basic AVS with three parts: a trigger, a service compo
 
 Triggers are the actions or events that prompt your service to be run. Currently, WAVS supports triggers from on-chain events (with support for cron schedules and off-chain triggers coming soon). On-chain event triggers can be used to pass arbitrary data as the inputs for service components to be run. Operators running a service listen for specific trigger events and run the corresponding service component.
 
-<img alt="WAVS" src="/diagrams/trigger.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/diagrams/trigger.png" />
 
 To learn more about triggers, visit the [How it works](./how-it-works#triggers) page.
 
@@ -53,7 +53,7 @@ Service components are the core logic of an AVS. They are written in Rust (with
 
 Service components can contain logic for processing input data from triggers. If an on-chain trigger passes data, a service component can use that data as input. For example, a simple service component could contain logic for receiving a number as input and returning the square of that number as output.
 
-<img alt="WAVS" src="/diagrams/service.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/diagrams/service.png" />
 
 To learn more about service components, visit the [How it works](/how-it-works#service-components) page. Check out the [WAVS tutorial](./tutorial/1-overview) to learn how to create a service component.
 
@@ -67,7 +67,7 @@ Along with your component, you'll also need to define how the results of your se
 
 Once a trigger, a service component, and submission logic are created, you can deploy your service. Operators will then listen for the triggers specified by your service. Once triggered, operators will run your service off-chain, where data from a trigger is passed to a service component and run in a sandboxed WASI environment. Operators sign the result of the service computation and the verified result can be returned as an on-chain response.
 
-<img alt="WAVS" src="/diagrams/wavs-flow.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/diagrams/wavs-flow.png" />
 
 
 With WAVS, service updates are streamlined: updates to services can be made by AVS builders directly without needing to coordinate with operators. Operators only need to upgrade if there is a change to the WAVS node software itself.
@@ -84,4 +84,4 @@ The WAVS platform is secured via Ethereum restaking on EigenLayer, which provide
 
 WAVS enables full-stack decentralization by unifying off-chain computation with on-chain verifiability. The chain layer connects to Ethereum and other chains, while the security layer extends cryptoeconomic security via EigenLayer restaking. At the AVS layer, lightweight WAVS powers WASM-based services to process off-chain computations triggered by on-chain events. Operators validate, sign, and commit the results back on-chain, ensuring verifiability and trust-minimized execution. This architecture makes WAVS a scalable, decentralized framework for full-stack applications.
 
-<img alt="WAVS" src="/diagrams/security.png" />
+<img alt="WAVS" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/diagrams/security.png" />
diff --git a/content/docs/tutorial/1-overview.mdx b/content/docs/tutorial/1-overview.mdx
@@ -5,9 +5,9 @@ import { HomeIcon, AppWindow, CircuitBoard, Layers, Microscope, Grid2x2, CloudSu
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 import { Scrollycoding } from "@/components/scrollycoding";
-import { link } from "@/components/link.tsx"
+import { link } from "@/components/link.tsx";
 
-<img alt="Start-building" src="/start-building.png" />
+<img alt="Start-building" src="https://raw.githubusercontent.com/Lay3rLabs/WAVS-docs/refs/heads/main/public/start-building.png" />
 
 In this guide, you will build a simple oracle service that fetches Bitcoin price data from [coinmarketcap.com](https://coinmarketcap.com/api/). This example is built using the [WAVS Foundry Template](https://github.com/Lay3rLabs/wavs-foundry-template), which contains the tools you need to build your own custom service.
 
diff --git a/content/docs/tutorial/4-component.mdx b/content/docs/tutorial/4-component.mdx
@@ -1,11 +1,10 @@
 ---
 title: 4. Oracle component walkthrough
 ---
-
-import { HoverContainer } from "@/components/hover-container"
+import { HoverContainer } from "@/components/hover-container";
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Scrollycoding } from "@/components/scrollycoding";
-import { link } from "@/components/link.tsx"
+import { link } from "@/components/link.tsx";
 
 The core logic of the price oracle in this example is located in the [`/eth-price-oracle/src/lib.rs` file](https://github.com/Lay3rLabs/wavs-foundry-template/tree/v0.3.0-rc1/components/eth-price-oracle/src/lib.rs). Scroll down to follow a walkthrough of the code for the oracle component.
 
diff --git a/content/docs/tutorial/5-build.mdx b/content/docs/tutorial/5-build.mdx
@@ -4,7 +4,6 @@ title: 5. Build and test components
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 <Callout title="Before proceeding" type="warn">
 
 {/* This section is also in [](./2-setup.mdx). Remember to update there as well */}
diff --git a/content/docs/tutorial/6-run-service.mdx b/content/docs/tutorial/6-run-service.mdx
@@ -4,7 +4,6 @@ title: 6. Run your service
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 ## Start Anvil, WAVS, and Deploy Eigenlayer
 
 1. Create a `.env` file for your project by copying over the example with the following command:
diff --git a/content/docs/tutorial/7-prediction.mdx b/content/docs/tutorial/7-prediction.mdx
@@ -4,7 +4,6 @@ title: 7. Prediction market
 import { Callout } from 'fumadocs-ui/components/callout';
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-
 Now that you've built a simple oracle service, take a look at the [WAVS Demo Repo](https://github.com/Lay3rLabs/wavs-demos/blob/main/demos/PREDICTION_MARKET_DEMO.md) to see a similar component used in action to resolve a prediction market.
 
 This page will give an overview of the prediction market demo, how it works, and how the oracle component is used to resolve markets.
@@ -78,7 +77,7 @@ Performing this market resolution via WAVS means prediction markets can exist in
 
 You can run the prediction market demo locally by following the steps from the [README](https://github.com/Lay3rLabs/wavs-demos/blob/main/demos/PREDICTION_MARKET_DEMO.md).
 
-Follow along in the video tutorial to see how to run the prediction market demo locally: 
+Follow along in the video tutorial to see how to run the prediction market demo locally:
 
 
 
diff --git a/last_commit_sync.txt b/last_commit_sync.txt
@@ -0,0 +1 @@
+5dcdf0f951a99c75444eb4b1285323c7bb1a42f9
diff --git a/scripts/sync_latest_docs.py b/scripts/sync_latest_docs.py
