Skip to content

feat: rich documentation, sync workflow, and slim README#89

Merged
neonwatty merged 1 commit into
mainfrom
feat/docs-and-sync-workflow
Apr 5, 2026
Merged

feat: rich documentation, sync workflow, and slim README#89
neonwatty merged 1 commit into
mainfrom
feat/docs-and-sync-workflow

Conversation

@neonwatty
Copy link
Copy Markdown
Collaborator

Summary

  • 10 MDX doc pages in docs/website/ (~9,600 words total) covering all widget features pulled from the README
  • GitHub Action (sync-docs.yml) that automatically syncs docs/website/*.mdxbugdrop-web/src/content/docs/ on push to main
  • Slimmed README from 500 → 76 lines, keeping Quick Start and linking to bugdrop.dev/docs for everything else

New doc pages

Page Words Covers
getting-started 672 Overview, 3-step flow, feature list
installation 779 GitHub App setup, script tag, CSP/async notes
configuration 1,046 All data-* attributes, categories, system info
styling 911 Style attributes, Shadow DOM, 4 design examples
javascript-api 835 window.BugDrop API, events, React integration
version-pinning 734 URL table, upgrade guide
ci-testing 1,169 Playwright test suite, CI workflow YAML
security 1,165 Permissions, storage, rate limiting
self-hosting 689 Architecture, requirements
faq 1,633 17 questions across 5 categories

Sync workflow

Requires BUGDROP_WEB_TOKEN secret (PAT with repo scope on bugdrop-web).

Test plan

  • Verify MDX files render correctly when copied to bugdrop-web
  • Test sync workflow with a PAT once secret is configured
  • Verify slimmed README links all point to correct bugdrop.dev/docs pages

@neonwatty neonwatty enabled auto-merge April 5, 2026 18:52
- 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
@neonwatty neonwatty force-pushed the feat/docs-and-sync-workflow branch from 3e77672 to de8bf5c Compare April 5, 2026 18:54
@neonwatty neonwatty added this pull request to the merge queue Apr 5, 2026
Merged via the queue into main with commit 2ca14f7 Apr 5, 2026
8 checks passed
@neonwatty neonwatty deleted the feat/docs-and-sync-workflow branch April 5, 2026 18:59
@github-actions
Copy link
Copy Markdown

ghost commented Apr 5, 2026

🎉 This PR is included in version 1.23.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant