https://github.com/hayek/appfeedback-docs
Documentation for the AppFeedback multi-platform feedback SDK family (Astro + Starlight).
https://github.com/hayek/appfeedback-docs
astro documentation feedback starlight
Last synced: 20 days ago
JSON representation
Documentation for the AppFeedback multi-platform feedback SDK family (Astro + Starlight).
- Host: GitHub
- URL: https://github.com/hayek/appfeedback-docs
- Owner: hayek
- License: mit
- Created: 2026-06-06T19:08:28.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2026-06-06T21:23:48.000Z (22 days ago)
- Last Synced: 2026-06-06T22:19:03.922Z (22 days ago)
- Topics: astro, documentation, feedback, starlight
- Language: HTML
- Homepage: https://hayek.github.io/appfeedback-docs/
- Size: 1.5 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# appfeedback-docs
The documentation site for the [AppFeedback](https://github.com/hayek) SDK family (Apple · Android · Web), built with [Astro Starlight](https://starlight.astro.build).
## Develop
```bash
pnpm install
pnpm dev # local dev server
pnpm build # static build → dist/
pnpm preview # preview the build
```
## Design
A "refined engineering / blueprint" theme: dark-first warm ink, a single amber accent, **Fraunces** display + **Public Sans** body + **JetBrains Mono** code, and a blueprint-grid hero. Theme tokens live in `src/styles/theme.css` (it overrides Starlight's CSS custom properties — the amber accent, the fonts, and the landing/hero styling).
## Structure
- `src/content/docs/index.mdx` — landing (splash hero, multi-language quickstart tabs, feature cards, relay flow).
- `src/content/docs/guides/` — quickstart, installation, the relay, security model, theming & localization.
- `src/content/docs/reference/` — the wire format, and the per-language API references. The references are generated by `swift-docc-plugin` / Dokka / TypeDoc via `scripts/regen-api-refs.sh` and committed under `public/reference/{swift,kotlin,kotlin-compose,typescript}/` (`kotlin-compose` is the `:android` Compose module), served as-is by the Astro build.
## Deploy
Deployed to GitHub Pages via `.github/workflows/deploy.yml` (uses `withastro/action`). It's configured as a **project page** — `base: '/appfeedback-docs'` + `site: 'https://hayek.github.io'` in `astro.config.mjs` (change these if you deploy elsewhere). Vercel and Cloudflare Pages also work with zero config (build command `pnpm build`, output `dist`).