[PR #354] [MERGED] Move canonical docs to the website #7926

Closed
opened 2026-08-22 17:31:53 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/RayLabsHQ/gitea-mirror/pull/354
Author: @arunavo4
Created: 8/3/2026
Status: ✅ Merged
Merged: 8/3/2026
Merged by: @arunavo4

Base: main ← Head: docs/site-revamp


📝 Commits (2)

  • c582bb9 docs: move canonical documentation to the website
  • b1e47b1 docs: mark new-repo notification as unimplemented, bump helm appVersion to 3.24.0

📊 Changes

27 files changed (+2840 additions, -2931 deletions)

View changed files

📝 README.md (+10 -7)
📝 docs/NOTIFICATIONS.md (+48 -1)
📝 helm/gitea-mirror/Chart.yaml (+2 -2)
📝 src/components/NotFound.tsx (+1 -1)
📝 src/components/layout/Sidebar.tsx (+2 -2)
📝 src/layouts/main.astro (+1 -1)
➖ src/pages/docs/advanced.astro (+0 -525)
➖ src/pages/docs/architecture.astro (+0 -340)
➖ src/pages/docs/authentication.astro (+0 -536)
➖ src/pages/docs/ca-certificates.astro (+0 -476)
➖ src/pages/docs/configuration.astro (+0 -514)
📝 src/pages/docs/index.astro (+3 -87)
➖ src/pages/docs/quickstart.astro (+0 -438)
📝 www/src/components/Header.tsx (+2 -1)
➕ www/src/layouts/DocsLayout.astro (+281 -0)
➕ www/src/lib/docs-nav.ts (+42 -0)
➕ www/src/pages/docs/advanced.mdx (+212 -0)
➕ www/src/pages/docs/architecture.mdx (+196 -0)
➕ www/src/pages/docs/authentication.mdx (+260 -0)
➕ www/src/pages/docs/ca-certificates.mdx (+249 -0)

...and 7 more files

📄 Description

Moves the canonical documentation to the website at gitea-mirror.raylabs.io/docs, per the docs audit and the decision to keep the repo markdown as the offline reference.

What this does

New docs site (www): a proper docs layout with sidebar navigation, on-page table of contents, mobile nav, dark and light theme, canonical and OG meta, and overflow-safe code blocks. Ten pages written fresh from the current code, not copied from the old in-app docs:

  • Quickstart and Deployment (Docker prebuilt image, build from source, Helm, Nix, LXC, bare metal)
  • Configuration guide and a complete Environment Variables reference
  • Notifications: all four providers, including the Webhook payload and X-Webhook-Signature HMAC verification with a receiver example
  • Authentication and SSO, including header authentication for reverse proxies
  • Force-Push Protection, Architecture, Advanced, Custom CA Certificates

Audit fixes baked in (all six critical inaccuracies from the docs audit): correct ghcr.io/raylabshq/gitea-mirror image name, BETTER_AUTH_SECRET instead of the legacy JWT_SECRET story, auth env vars documented on the configuration page, correct DATABASE_URL default, consistent starred-org default, and the health endpoint documented as it actually responds.

App changes: in-app /docs pages retired with a redirect stub for old bookmarks; sidebar and 404 links go straight to the website; viewport meta fixed with initial-scale=1.

Repo markdown stays as the offline reference: NOTIFICATIONS.md now covers Gotify and Webhook (with signature verification code), README links the docs site and mentions notifications.

Screenshots

Docs page with sidebar and table of contents

Notifications docs

Configuration guide with embedded app screenshot

Configuration docs

Mobile

Mobile docs

Testing

  • bun run build in www passes; all eleven docs routes return 200 in preview
  • Clicked through desktop and mobile, dark theme verified, embedded images render
  • The old audit report was used as the checklist; every CRITICAL and MISSING item is addressed except the Repositories/Organizations/Activity page screenshots for the site gallery, which are unchanged on purpose

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/RayLabsHQ/gitea-mirror/pull/354 **Author:** [@arunavo4](https://github.com/arunavo4) **Created:** 8/3/2026 **Status:** ✅ Merged **Merged:** 8/3/2026 **Merged by:** [@arunavo4](https://github.com/arunavo4) **Base:** `main` ← **Head:** `docs/site-revamp` --- ### 📝 Commits (2) - [`c582bb9`](https://github.com/RayLabsHQ/gitea-mirror/commit/c582bb9508c31e321aca1ff841e5b131cec3d976) docs: move canonical documentation to the website - [`b1e47b1`](https://github.com/RayLabsHQ/gitea-mirror/commit/b1e47b1b5dae19269003dc573d08d17f71907d66) docs: mark new-repo notification as unimplemented, bump helm appVersion to 3.24.0 ### 📊 Changes **27 files changed** (+2840 additions, -2931 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+10 -7) 📝 `docs/NOTIFICATIONS.md` (+48 -1) 📝 `helm/gitea-mirror/Chart.yaml` (+2 -2) 📝 `src/components/NotFound.tsx` (+1 -1) 📝 `src/components/layout/Sidebar.tsx` (+2 -2) 📝 `src/layouts/main.astro` (+1 -1) ➖ `src/pages/docs/advanced.astro` (+0 -525) ➖ `src/pages/docs/architecture.astro` (+0 -340) ➖ `src/pages/docs/authentication.astro` (+0 -536) ➖ `src/pages/docs/ca-certificates.astro` (+0 -476) ➖ `src/pages/docs/configuration.astro` (+0 -514) 📝 `src/pages/docs/index.astro` (+3 -87) ➖ `src/pages/docs/quickstart.astro` (+0 -438) 📝 `www/src/components/Header.tsx` (+2 -1) ➕ `www/src/layouts/DocsLayout.astro` (+281 -0) ➕ `www/src/lib/docs-nav.ts` (+42 -0) ➕ `www/src/pages/docs/advanced.mdx` (+212 -0) ➕ `www/src/pages/docs/architecture.mdx` (+196 -0) ➕ `www/src/pages/docs/authentication.mdx` (+260 -0) ➕ `www/src/pages/docs/ca-certificates.mdx` (+249 -0) _...and 7 more files_ </details> ### 📄 Description Moves the canonical documentation to the website at [gitea-mirror.raylabs.io/docs](https://gitea-mirror.raylabs.io/docs/), per the docs audit and the decision to keep the repo markdown as the offline reference. ## What this does **New docs site** (www): a proper docs layout with sidebar navigation, on-page table of contents, mobile nav, dark and light theme, canonical and OG meta, and overflow-safe code blocks. Ten pages written fresh from the current code, not copied from the old in-app docs: - Quickstart and Deployment (Docker prebuilt image, build from source, Helm, Nix, LXC, bare metal) - Configuration guide and a complete Environment Variables reference - Notifications: all four providers, including the Webhook payload and X-Webhook-Signature HMAC verification with a receiver example - Authentication and SSO, including header authentication for reverse proxies - Force-Push Protection, Architecture, Advanced, Custom CA Certificates **Audit fixes baked in** (all six critical inaccuracies from the docs audit): correct `ghcr.io/raylabshq/gitea-mirror` image name, `BETTER_AUTH_SECRET` instead of the legacy `JWT_SECRET` story, auth env vars documented on the configuration page, correct `DATABASE_URL` default, consistent starred-org default, and the health endpoint documented as it actually responds. **App changes**: in-app /docs pages retired with a redirect stub for old bookmarks; sidebar and 404 links go straight to the website; viewport meta fixed with `initial-scale=1`. **Repo markdown stays as the offline reference**: NOTIFICATIONS.md now covers Gotify and Webhook (with signature verification code), README links the docs site and mentions notifications. ## Screenshots ### Docs page with sidebar and table of contents ![Notifications docs](https://gist.githubusercontent.com/arunavo4/ce67ba58f3795c572a76c000e40ec415/raw/f09b6da8fe87f1bc91db01f293e4aeb208ea6d68/docs-notifications-preview.png) ### Configuration guide with embedded app screenshot ![Configuration docs](https://gist.githubusercontent.com/arunavo4/ce67ba58f3795c572a76c000e40ec415/raw/f09b6da8fe87f1bc91db01f293e4aeb208ea6d68/docs-config-preview.png) ### Mobile ![Mobile docs](https://gist.githubusercontent.com/arunavo4/ce67ba58f3795c572a76c000e40ec415/raw/f09b6da8fe87f1bc91db01f293e4aeb208ea6d68/docs-mobile-preview.png) ## Testing - `bun run build` in www passes; all eleven docs routes return 200 in preview - Clicked through desktop and mobile, dark theme verified, embedded images render - The old audit report was used as the checklist; every CRITICAL and MISSING item is addressed except the Repositories/Organizations/Activity page screenshots for the site gallery, which are unchanged on purpose --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-08-22 17:31:53 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea-mirror#7926