Skip to content

Commit de8bf5c

Browse files
committed
feat: add rich documentation, sync workflow, and slim README
- Create 10 comprehensive MDX doc pages in docs/website/ (~9600 words total) covering installation, configuration, styling, JS API, version pinning, CI testing, security, self-hosting, and FAQ - Add GitHub Action workflow to sync docs/website/*.mdx to bugdrop-web repo on push to main, triggering Vercel redeploy - Slim README from 500 to 76 lines, keeping quick start and linking to bugdrop.dev/docs for full documentation
1 parent 7216899 commit de8bf5c

12 files changed

Lines changed: 1908 additions & 450 deletions

.github/workflows/sync-docs.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Sync docs to bugdrop-web
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/website/**'
8+
9+
jobs:
10+
sync:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout bugdrop
14+
uses: actions/checkout@v4
15+
16+
- name: Checkout bugdrop-web
17+
uses: actions/checkout@v4
18+
with:
19+
repository: mean-weasel/bugdrop-web
20+
path: bugdrop-web
21+
token: ${{ secrets.BUGDROP_WEB_TOKEN }}
22+
23+
- name: Sync docs
24+
run: |
25+
cp docs/website/*.mdx bugdrop-web/src/content/docs/
26+
cd bugdrop-web
27+
git config user.name "github-actions[bot]"
28+
git config user.email "github-actions[bot]@users.noreply.github.com"
29+
git add src/content/docs/
30+
if git diff --cached --quiet; then
31+
echo "No documentation changes to sync"
32+
else
33+
git commit -m "docs: sync documentation from bugdrop repo"
34+
git push
35+
fi

0 commit comments

Comments
 (0)