From bc021b449c5b29627bfe834ef0ffcc3c8d46ebd4 Mon Sep 17 00:00:00 2001 From: Addison Date: Tue, 4 Nov 2025 09:22:55 -0500 Subject: [PATCH 1/4] fix: paths --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 654832f..84a9224 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Images can be added to `src/assets/` and embedded in Markdown with a relative link. -Static assets, like favicons, can be placed in the `static/` directory. +Static assets, like favicons, can be placed in the `public/` directory. ## Commands @@ -40,4 +40,4 @@ All commands are run from the root of the project, from a terminal: | :-------------- | :------------------------------------------ | | `npm install` | Installs dependencies | | `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./public/` | +| `npm run build` | Build your production site to `dist/` | From 0e2a82068c728f13be009a191b1f3a30d9f23150 Mon Sep 17 00:00:00 2001 From: Addison Date: Tue, 4 Nov 2025 09:27:34 -0500 Subject: [PATCH 2/4] docs: move step --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84a9224..dcf3fe0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ Follow these steps in every new docs repository. - [ ] "GitHub Actions" as source - [ ] Add DNS config in AWS Route 53 - [ ] Add custom domain in GitHub - - [ ] Enable "Enforce HTTPS" - [ ] Create a pull request - [ ] Update the title in the README - [ ] Update the URL in the README @@ -23,6 +22,7 @@ Follow these steps in every new docs repository. - [ ] Remove the "New Project Checklist" from the README - [ ] Merge the pull request - [ ] Verify that deployment is successful +- [ ] Enable "Enforce HTTPS" in the GitHub pages settings (it does not seem you can do it until you have a deployment) ## Project Structure From 2aca86766d67adea6c3d519cd4a87c924e773e60 Mon Sep 17 00:00:00 2001 From: Addison Date: Tue, 4 Nov 2025 09:42:19 -0500 Subject: [PATCH 3/4] chore: add name to package.json --- README.md | 1 + package-lock.json | 3 ++- package.json | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcf3fe0..5dd9834 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ Follow these steps in every new docs repository. - [ ] Update `astro.config.mjs` with appropriate configuration - [ ] Update `src/content/docs/index.mdx` with appropriate information - [ ] Update `public/site.webmanifest` with appropriate information + - [ ] Update `package.json` with project name - [ ] Add any initial content - [ ] Remove the "New Project Checklist" from the README - [ ] Merge the pull request diff --git a/package-lock.json b/package-lock.json index d32fb0e..11532c7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,11 @@ { - "name": "docs-template", + "name": "Docs Template", "version": "0.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { + "name": "Docs Template", "dependencies": { "@astrojs/starlight": "^0.36.2", "astro": "^5.6.1", diff --git a/package.json b/package.json index 498d606..ae481f7 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,5 @@ { + "name": "Docs Template", "private": true, "type": "module", "scripts": { From 6d0d2784be018eae52ae1f7f6c992b38a8c20bd2 Mon Sep 17 00:00:00 2001 From: Addison Date: Tue, 4 Nov 2025 09:48:44 -0500 Subject: [PATCH 4/4] fix: missing deploy workflow --- .github/workflows/deploy.yaml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/deploy.yaml diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml new file mode 100644 index 0000000..c2838e0 --- /dev/null +++ b/.github/workflows/deploy.yaml @@ -0,0 +1,34 @@ +name: Deploy to GitHub Pages + +on: + # Trigger the workflow every time you push to the `main` branch + push: + branches: [ main ] + # Allows you to run this workflow manually from the Actions tab on GitHub. + workflow_dispatch: + +# Allow this job to clone the repo and create a page deployment +permissions: + contents: read + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout your repository using git + uses: actions/checkout@v4 + - name: Install, build, and upload your site + uses: withastro/action@v3 + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4