Skip to main content

Repository Setup

This docs repo is intended to sit alongside the application repos:

  • devrel-insights
  • devrel-insights-admin
  • devrel-insights-docs

These repository names still use legacy devrel identifiers during the broader Builder Insights rename.

Local setup​

cd /path/to/devrel-insights-docs
npm install
npm run start

Build verification​

npm run build

Screenshot automation​

Mobile screenshots​

Source automation currently lives in the mobile app repo.

Admin screenshots​

This docs repo includes a hosted admin capture script:

npm run screenshots:admin

Default demo credentials are built into the script for the shared demo environment, but can be overridden with:

  • ADMIN_BASE_URL
  • ADMIN_DEMO_EMAIL
  • ADMIN_DEMO_CODE

Git remote​

Current remote target:

  • https://github.com/mongodb-developer/devrel-insights-docs.git

Recommended content ownership​

Keep here​

  • system-level architecture
  • cross-repo workflows
  • operational runbooks
  • screenshots and UX walkthroughs
  • release and testing checklists that touch both apps

Keep in app repos​

  • code-adjacent implementation notes
  • repo-specific setup details
  • fine-grained API or screen behavior notes that evolve with code

Publishing note​

Before first publish, decide whether the site will be deployed with GitHub Pages, Vercel, or another static host and update docusaurus.config.ts accordingly.