Jatin K MalikandGitHub
f48bdda525
* docs: polish project documentation for a clearer public surface Rewrite the README and supporting docs for a more professional first impression: less emoji and badge noise, install-first structure, and a real documentation index. Add a Contributor Covenant, tighten SECURITY and GitHub templates, and make distro/update guides read as product docs instead of internal status notes. * docs: split install guide and add changelog plus support pages Break INSTALL.md into a short primary guide, manual/PyPI package lists, and troubleshooting. Add root CHANGELOG.md and SUPPORT.md, wire them into the docs index and README, and drop the outdated screenshot lag note now that v0.15 assets are on main. * docs: humanize PR copy and remove em dashes Strip em/en dashes from the documentation rewritten in this PR, fix mid-sentence colon fallout from that pass, and smooth a few stiff phrases so the public docs read more natural. * docs: list Faster Whisper after rebase onto main Installer and CLI already accept faster_whisper. Document it next to the other engines, drop the outdated screenshot lag note, and keep the on-device wording honest for local vs remote.
91 lines
2.0 KiB
Markdown
91 lines
2.0 KiB
Markdown
# Vocalinux website
|
|
|
|
Marketing site for [vocalinux.com](https://vocalinux.com), built with Next.js and deployed as a static export (GitHub Pages).
|
|
|
|
Product claims and design constraints: [PRODUCT.md](PRODUCT.md), [DESIGN.md](DESIGN.md). Agent notes: [AGENTS.md](AGENTS.md).
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## Production build
|
|
|
|
```bash
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
Static output is written to `out/`.
|
|
|
|
### Local preview of the build
|
|
|
|
```bash
|
|
cd out
|
|
python3 -m http.server 3000
|
|
```
|
|
|
|
Open `http://localhost:3000`.
|
|
|
|
## Scripts
|
|
|
|
| Script | Purpose |
|
|
|--------|---------|
|
|
| `npm run dev` | Dev server |
|
|
| `npm run build` | Production static export |
|
|
| `npm run deploy` | Build and prepare GitHub Pages (`.nojekyll`, `CNAME`) |
|
|
| `npm run lint` | ESLint |
|
|
| `npm run typecheck` | TypeScript |
|
|
|
|
## Deployment
|
|
|
|
Push to `main` triggers the site workflow. Production host: **vocalinux.com**.
|
|
|
|
Manual path:
|
|
|
|
```bash
|
|
cd web
|
|
npm install
|
|
npm run deploy
|
|
```
|
|
|
|
That produces `out/` with `.nojekyll` and a `CNAME` for vocalinux.com.
|
|
|
|
## Layout
|
|
|
|
```
|
|
web/
|
|
├── src/
|
|
│ ├── app/ # Next.js app routes
|
|
│ ├── components/
|
|
│ │ ├── site-chrome.tsx
|
|
│ │ └── ui/ # Reusable UI components
|
|
│ ├── hooks/
|
|
│ └── lib/
|
|
├── public/ # Static assets and screenshots
|
|
├── out/ # Build output (generated)
|
|
└── package.json
|
|
```
|
|
|
|
## Configuration notes
|
|
|
|
- Custom domain: `deploy` script writes `out/CNAME`
|
|
- Subdirectory deploy: set `basePath` in `next.config.js` if needed
|
|
- Family workbench UI: warm paper, system type, same language as VocaHQ ([DESIGN.md](DESIGN.md))
|
|
|
|
## Troubleshooting
|
|
|
|
| Symptom | Check |
|
|
|---------|--------|
|
|
| Module not found | `npm install` |
|
|
| Type errors | `npm run typecheck` |
|
|
| Lint errors | `npm run lint` |
|
|
| 404 on GitHub Pages | Ensure `out/.nojekyll` exists |
|
|
| Assets 404 | Confirm `basePath` matches deploy path |
|
|
|
|
## License
|
|
|
|
Same as the main Vocalinux project ([AGPL-3.0](../LICENSE)).
|