30612a0d87
Sort docs/ into guide/ contributing/ architecture/ roadmap/ and rename to consistent kebab-case (USER->guide/install-and-use, FOOTPRINT-> architecture/system-footprint, frontend-modularization->architecture/ webui-architecture, etc.). Add a docs/README.md index and a docs/ CONTRIBUTING.md pointer so the forge still surfaces the contributing guide. Fix every reference (README, init.sh comments, frontend code comments, and the USER<->DEVELOPMENT cross-links). History preserved via git mv. Root stays README.md + CLAUDE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: librelad <librelad@digitalangels.vip>
20 lines
1.1 KiB
Markdown
20 lines
1.1 KiB
Markdown
# LibrePortal docs
|
|
|
|
Sorted by audience. Start with **guide/** if you're running LibrePortal,
|
|
**contributing/** if you're hacking on it.
|
|
|
|
## guide/ — using LibrePortal
|
|
- [install-and-use.md](guide/install-and-use.md) — install, place data on separate disks, update, back up, uninstall.
|
|
- [promise.md](guide/promise.md) — the LibrePortal Promise: free/open, no paywalls, no telemetry, in plain language.
|
|
|
|
## contributing/ — working on LibrePortal
|
|
- [contributing.md](contributing/contributing.md) — how to contribute (DCO sign-off, no CLA).
|
|
- [development.md](contributing/development.md) — run a dev copy, cut stable/edge releases, test before publishing.
|
|
|
|
## architecture/ — how it's built
|
|
- [system-footprint.md](architecture/system-footprint.md) — everything LibrePortal places outside its data roots, and who owns it.
|
|
- [webui-architecture.md](architecture/webui-architecture.md) — the WebUI component-module system (as-built).
|
|
|
|
## roadmap/ — where it's going
|
|
- [updates-and-distribution.md](roadmap/updates-and-distribution.md) — vision for hotfixes, the "Updates & Improvements" front door, and registry-not-marketplace distribution.
|