mirror of
https://github.com/RayLabsHQ/gitea-mirror.git
synced 2026-10-30 22:21:58 +01:00
ARUNAVO RAY
5c49191d61
* docs: move canonical documentation to the website The website now hosts the full documentation at /docs with a proper docs layout: sidebar navigation, on-page table of contents, mobile nav, theme support, canonical and OG meta, and overflow-safe code blocks and tables. Ten pages, all rewritten from the current code rather than copied from the old in-app docs: quickstart, deployment (Docker, Helm, Nix, LXC, bare metal), configuration, environment variable reference, notifications (all four providers including webhook payload signing), authentication (including header auth), force-push protection, architecture, advanced, and custom CA certificates. This fixes every inaccuracy found in the docs audit: the wrong raylabs/gitea-mirror image name, JWT_SECRET presented as the live auth secret instead of BETTER_AUTH_SECRET, the missing auth env vars, both wrong DATABASE_URL defaults, the contradicting starred-org default, and health endpoint fields the API deliberately does not return. The in-app /docs pages are retired: a stub redirects old bookmarks to the website, and the sidebar and 404 links point there directly. The markdown files under docs/ stay as the versioned offline reference; NOTIFICATIONS.md now covers Gotify and Webhook. README links the docs site, mentions notifications, and drops stale version markers. The app viewport meta gains initial-scale=1. * docs: mark new-repo notification as unimplemented, bump helm appVersion to 3.24.0
Gitea Mirror Marketing Site
This Astro workspace powers the public marketing experience for Gitea Mirror. It includes the landing page, screenshots, call-to-action components, and the new use case library that highlights real-world workflows.
Developing Locally
bun install
bun run dev
The site is available at http://localhost:4321. Tailwind CSS v4 handles styling; classes can be used directly inside Astro, MDX, and React components.
Project Structure
src/pages/index.astro– Main landing pagesrc/components/– Reusable UI (Header, Hero, Features, UseCases, etc.)src/lib/use-cases.ts– Central data source for use case titles, summaries, and tagssrc/pages/use-cases/– MDX guides for each use case, rendered withUseCaseLayoutsrc/layouts/UseCaseLayout.astro– Shared layout that injects the header, shader background, and footer into MDX guides
Authoring Use Case Guides
- Add or update a record in
src/lib/use-cases.ts. This keeps the landing page and library listing in sync. - Create a new MDX file in
src/pages/use-cases/<slug>.mdxwith theUseCaseLayoutlayout and descriptive frontmatter. - Run
bun run devto preview the layout and ensure the new guide inherits global styles.
Deployment
The marketing site is built with the standard Astro pipeline. Use bun run build to generate a production build before deploying.