From 437e57062446a43d28452fc742451769f50a8320 Mon Sep 17 00:00:00 2001 From: PianoNic <79938743+Pianonic@users.noreply.github.com> Date: Wed, 12 Aug 2026 12:47:23 +0200 Subject: [PATCH] Point the README at the docs site Trim the sections that the published docs already own, link each remaining topic to its page on docs.schuly.dev, and list every repo in the ecosystem table. --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 138b9b4..feebd44 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,33 @@

GitHub stars Angular + Documentation Website

-Angular-based marketing site for Schuly. Hosts the public landing page, app downloads, and project documentation. +Angular marketing site for Schuly. Hosts the public landing page and app downloads, in five languages with per-language prerendered URLs. + +Project documentation lives at [docs.schuly.dev](https://docs.schuly.dev), not on this site. + +## Quick start + +```sh +bun install +bun start # ng serve on http://localhost:4200 +bun run build # production build +``` + +## Documentation + +Full documentation lives at **[docs.schuly.dev/SchulyWebsite](https://docs.schuly.dev/SchulyWebsite/)**. + +| Guide | What it covers | +|---|---| +| [Development setup](https://docs.schuly.dev/SchulyWebsite/setup/development) | Prerequisites, install, run, watch, and tests. | +| [Deployment](https://docs.schuly.dev/SchulyWebsite/setup/deployment) | How the site is built and published. | +| [Release](https://docs.schuly.dev/SchulyWebsite/setup/release) | Cutting a release. | +| [Architecture](https://docs.schuly.dev/SchulyWebsite/architecture) | App structure, i18n, and prerendering. | +| [Contributing](https://docs.schuly.dev/SchulyWebsite/contributing) | Workflow, branch and PR conventions. | ## The Schuly ecosystem @@ -19,19 +42,8 @@ Angular-based marketing site for Schuly. Hosts the public landing page, app down |---|---| | [**Schuly**](https://github.com/schulydev/Schuly) | Flutter mobile app | | [**SchulyBackend**](https://github.com/schulydev/SchulyBackend) | ASP.NET Core API backend | +| [**SchulyKeycloak**](https://github.com/schulydev/SchulyKeycloak) | Keycloak image + the `schuly` realm | | [**SchulyPluginAbstractions**](https://github.com/schulydev/SchulyPluginAbstractions) | Plugin contract (NuGet) | | [**SchulyPlugins**](https://github.com/schulydev/SchulyPlugins) | Official plugins monorepo | | [**SchulyWebsite**](https://github.com/schulydev/SchulyWebsite) | Landing site ([schuly.dev](https://schuly.dev)) *(this repo)* | - -## Run - -```sh -bun install -bun start # ng serve on http://localhost:4200 -``` - -## Build - -```sh -bun run build -``` +| [**SchulyDocs**](https://github.com/schulydev/SchulyDocs) | Documentation site ([docs.schuly.dev](https://docs.schuly.dev)) |