Files
docs.grlx.dev/README.md
Tai Groot 8c3a74ff0d docs: add license, CI, fix content quality, document rcd provider (#38)
- Add 0BSD LICENSE (matches gogrlx/grlx)
- Add GitHub Actions CI workflow (build + eslint)
- Fix eslint config: add ignores for .astro/dist, add typescript parser deps
- Update README: replace npm boilerplate with bun commands, add badges
- Document rc.d (BSD) service provider alongside systemd
- Update service ingredient to reference provider interface instead of claiming systemd-only
- Fix frontmatter: desc -> description in groups.md and user.md
- Close unclosed :::note directive in ingredients overview
- Fix typo in ingredients overview ('Check them out the list' -> 'Check out the list')
- Update astro 5.17.3 -> 5.18.0
2026-03-06 11:38:57 -05:00

30 lines
1.0 KiB
Markdown

# grlx docs
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
[![License: 0BSD](https://img.shields.io/badge/license-0BSD-blue)](LICENSE)
Documentation site for [grlx](https://github.com/gogrlx/grlx) — effective fleet configuration management.
Live at **[docs.grlx.dev](https://docs.grlx.dev)**
## Development
All commands are run from the root of the project:
| Command | Action |
| :--------------- | :------------------------------------------ |
| `bun install` | Install dependencies |
| `bun run dev` | Start local dev server at `localhost:4321` |
| `bun run build` | Build production site to `./dist/` |
| `bun run preview`| Preview the build locally before deploying |
## Stack
- [Astro](https://astro.build) + [Starlight](https://starlight.astro.build)
- [Tailwind CSS v4](https://tailwindcss.com)
- [Pagefind](https://pagefind.app) for search (built-in via Starlight)
## License
[0BSD](LICENSE)