Skip to content

Commit e3ca4db

Browse files
authored
added bug bounty page (#11)
* added bug bounty page * updated github deployments * removed yarn and npm package lockfiles, updated README to suggest pnpm * package updates, added site to config for sitemap
1 parent e879743 commit e3ca4db

10 files changed

Lines changed: 4229 additions & 16299 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,24 @@ jobs:
1212
name: Deploy to GitHub Pages
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v3
16-
- uses: actions/setup-node@v3
15+
- uses: actions/checkout@v4
16+
- uses: pnpm/action-setup@v4
1717
with:
18-
node-version: 18
19-
cache: yarn
18+
version: 9
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 24
22+
cache: pnpm
2023

2124
- name: Install dependencies
22-
run: yarn install --frozen-lockfile
25+
run: pnpm install --frozen-lockfile
2326
- name: Build website
24-
run: yarn build
27+
run: pnpm build
2528

2629
# Popular action to deploy to GitHub Pages:
2730
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
2831
- name: Deploy to GitHub Pages
29-
uses: peaceiris/actions-gh-pages@v3
32+
uses: peaceiris/actions-gh-pages@v4
3033
with:
3134
github_token: ${{ secrets.GITHUB_TOKEN }}
3235
# Build output to publish to the `gh-pages` branch:
@@ -37,4 +40,4 @@ jobs:
3740
# The GH actions bot is used by default if you didn't specify the two fields.
3841
# You can swap them out with your own user credentials.
3942
user_name: github-actions[bot]
40-
user_email: 41898282+github-actions[bot]@users.noreply.github.com
43+
user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/test-deploy.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ jobs:
1212
name: Test deployment
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v3
16-
- uses: actions/setup-node@v3
15+
- uses: actions/checkout@v4
16+
- uses: pnpm/action-setup@v4
1717
with:
18-
node-version: 18
19-
cache: yarn
18+
version: 9
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 24
22+
cache: pnpm
2023

2124
- name: Install dependencies
22-
run: yarn install --frozen-lockfile
25+
run: pnpm install --frozen-lockfile
2326
- name: Test build website
24-
run: yarn build
27+
run: pnpm build

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ Static assets, like favicons, can be placed in the `public/` directory.
4040

4141
All commands are run from the root of the project, from a terminal:
4242

43-
| Command | Action |
44-
| :------------------------ | :----------------------------------------------- |
45-
| `npm install` | Installs dependencies |
46-
| `npm run dev` | Starts local dev server at `localhost:4321` |
47-
| `npm run build` | Build your production site to `./dist/` |
48-
| `npm run preview` | Preview your build locally, before deploying |
49-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50-
| `npm run astro -- --help` | Get help using the Astro CLI |
43+
| Command | Action |
44+
| :------------------------- | :----------------------------------------------- |
45+
| `pnpm install` | Installs dependencies |
46+
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
47+
| `pnpm run build` | Build your production site to `./dist/` |
48+
| `pnpm run preview` | Preview your build locally, before deploying |
49+
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50+
| `pnpm run astro -- --help` | Get help using the Astro CLI |
5151

5252
## 👀 Want to learn more?
5353

astro.config.mjs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
import { defineConfig } from 'astro/config';
2-
import starlight from '@astrojs/starlight';
1+
import { defineConfig } from "astro/config";
2+
import starlight from "@astrojs/starlight";
33

44
export default defineConfig({
5+
site: "https://docs.magi.eco",
56
integrations: [
67
starlight({
7-
title: 'VSC Documentation',
8+
title: "VSC Documentation",
89
social: [
9-
{ icon: 'github', label: 'GitHub', href: 'https://github.com/vsc-eco' }
10+
{ icon: "github", label: "GitHub", href: "https://github.com/vsc-eco" },
1011
],
1112
// no sidebar config here — Starlight auto-generates sidebar from your content folder
1213
}),

0 commit comments

Comments
 (0)