diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml new file mode 100644 index 0000000000..543171dc79 --- /dev/null +++ b/.github/workflows/deploy_docs.yml @@ -0,0 +1,35 @@ +name: Deploy Docs + +on: + push: + branches: + - main + +jobs: + deploy-docs: + name: Deploy Docs + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + clean: false + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v2 + with: + mdbook-version: "0.4.37" + + - name: Build book + run: | + set -euo pipefail + mkdir -p target/deploy + mdbook build ./docs --dest-dir=../target/deploy/docs2/ + + - name: Deploy + uses: cloudflare/wrangler-action@v3 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} + command: pages deploy target/deploy --project-name=docs diff --git a/docs/.gitignore b/docs/.gitignore index eed3a3e046..3006b271da 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1 @@ -book -.vercel +book/ diff --git a/docs/book.toml b/docs/book.toml index 8062a76a42..7a0e30e04b 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -1,6 +1,7 @@ [book] -authors = ["Nate Butler"] +authors = ["The Zed Team"] language = "en" multilingual = false src = "src" -title = "Zed App Docs" +title = "Zed" +site-url = "/docs2/" diff --git a/docs/how-to-deploy.md b/docs/how-to-deploy.md deleted file mode 100644 index b1561c701f..0000000000 --- a/docs/how-to-deploy.md +++ /dev/null @@ -1,10 +0,0 @@ -These docs are intendended to replace both docs.zed.dev and introduce people to how to build Zed from source. - -1. `cd docs` from repo root -1. Install the vercel cli if you haven't already - - `pnpm i -g vercel` -1. `vercel` to deploy if you already have the project linked -1. Otherwise, `vercel login` and `vercel` to link - - Choose Zed Industries as the team, then `zed-app-docs` as the project - -Someone can write a script for this when they have time. diff --git a/docs/src/tasks.md b/docs/src/tasks.md new file mode 100644 index 0000000000..771f0fcc41 --- /dev/null +++ b/docs/src/tasks.md @@ -0,0 +1,3 @@ +# Tasks + +Tasks allow you to run certain actions from within Zed.