bgeo-docs

Documentation site for the BGeo SDK family (Astro + Starlight). Currently covers the React Native SDK; other platforms (Flutter, native iOS/Android) are stubbed on the root SDK-chooser page as "coming soon".

Develop

npm install
npm run dev      # local dev server
npm run build    # -> dist/ (static site)
npm run preview  # serve the built dist/ locally

npm run build runs, in order:

1. scripts/check-config-reference.mjs (npm run check:config) — fails the build if the hand-written Config reference page drifts from ../react-native/src/types.ts: every top-level Config key needs a matching ### key heading on the page, and every documented heading must still exist in code.
2. astro build — the Starlight build itself, which includes starlight-links-validator (fails on broken internal links) and renders Mermaid diagrams via astro-mermaid.

Deploy

.github/workflows/deploy.yml publishes to GitHub Pages on every push to main (or manually via workflow_dispatch). It checks out this repo and the four public SDK repos side by side (the config drift check reads ../react-native, ../flutter, ../ios and ../android), runs npm ci && npm run build in docs/, and assembles _site/ with the build under _site/docs/, a root index.html redirecting to /docs/, and a CNAME of bgeo.dev.

Content

• src/content/docs/index.mdx — root SDK chooser (links to the React Native SDK docs; other platforms marked "coming soon").
• src/content/docs/support.md — support (GitHub Issues per SDK repo).
• src/content/docs/privacy.md — privacy notes for the site and the SDK.
• src/content/docs/react-native/ — the React Native SDK docs:
  • index.mdx — introduction/overview.
  • getting-started/ — installation, quickstart, permissions & background location.
  • concepts/ — tracking lifecycle, data pipeline.
  • guides/ — HTTP & authorization, geofencing, boot & killed-app behavior, logging & debugging, migrating from Transistorsoft.
  • reference/ — methods, config (checked against code by scripts/check-config-reference.mjs), events, data types, constants, compatibility, limitations.

Old top-level paths (/getting-started/..., /guides/..., /reference/...) redirect to their /react-native/... equivalents; see redirects in astro.config.mjs.