feat: bootstrap Eldorado documentation and Pages publication
Build and publish Eldorado documentation / build (push) Successful in 30s

This commit is contained in:
jarvis-at-skic committed 2026-10-02 10:03:16 +00:00
1 parent dceabb9514
commit 98a0cb088f
17 files changed
+12749 -2

No files matched your search

+39
View File
@@ -0,0 +1,39 @@
---
title: How to update and publish the site
description: Preview documentation changes, validate them, and publish through Gitea Actions.
slug: /maintain
---
## What you need
Node.js 22 or later, pnpm 10.15.1, and write access to the private [documentation repository](https://gitea.lego-cloud.eu/eldorado-v1/documentation).
## Preview locally
```sh
pnpm install --frozen-lockfile
pnpm start
```
Open the development server address printed in the terminal. The site uses the `/eldorado-v1/documentation/` base path.
## Add or change a page
Edit Markdown in `docs/`. Include `title` and `description` frontmatter and add the page ID to `sidebars.ts`. Keep the documentation’s future scope open until it is agreed.
## Validate the change
```sh
pnpm verify
pnpm typecheck
pnpm build
pnpm verify:build
```
The build fails on broken internal links. The built-output checks verify routes, locally bundled fonts, search content, and the expected site base path.
## Publish
Open a pull request for subsequent changes. Gitea Actions validates pull requests without publishing. Once a change is merged to `main`, the workflow builds and copies the site to the persistent Pages mount at `/gondor-v1-gitea-pages/eldorado-v1/documentation/`.
Check the Actions result for that exact commit, then open [the published site](https://pages.apps.lego-cloud.eu/eldorado-v1/documentation/). Pages access follows the platform’s existing authentication policy; a sign-in redirect is not a failed build.
+21
View File
@@ -0,0 +1,21 @@
---
title: Explore the starting point
description: Understand what this documentation foundation includes and what is still undecided.
slug: /overview
---
This is the starting point for **Eldorado v1 documentation**. The purpose, audience, and content structure will be defined later.
## What is included
- A Docusaurus site with responsive navigation and local search.
- An Eldorado-inspired visual theme with a dark header, gold accents, and Lato typography.
- Automated checks on pull requests and publication to LEGO Cloud Pages after a push to `main`.
## What remains open
The documentation’s goals, ownership model, subject matter, and final information architecture are not yet agreed. This starter does not introduce product requirements, business claims, or a delivery roadmap.
## Work on the foundation
[Maintain and publish the site](./maintain.md) or [look up its configuration](./reference.md).
+39
View File
@@ -0,0 +1,39 @@
---
title: Site configuration reference
description: Look up source locations, tool versions, styling choices, and publication settings.
slug: /reference
---
## Repository layout
| Path | Responsibility |
| --- | --- |
| `docs/` | Documentation Markdown |
| `src/pages/index.tsx` | Homepage |
| `src/css/custom.css` | Eldorado-inspired theme |
| `static/img/docs-mark.svg` | Original documentation icon |
| `docusaurus.config.ts` | Routes, metadata, navigation, and search |
| `sidebars.ts` | Documentation navigation |
| `scripts/verify.mjs` | Source and built-output contract checks |
| `.gitea/workflows/pages.yml` | Validation and Pages publication |
## Runtime and publication
| Setting | Value |
| --- | --- |
| Framework | Docusaurus 3.10.2 |
| Node.js | 22 or later; CI uses 22 |
| Package manager | pnpm 10.15.1 |
| Base path | `/eldorado-v1/documentation/` |
| Repository | `eldorado-v1/documentation` (private) |
| Publication branch | `main` |
| Pages mount | `/gondor-v1-gitea-pages` |
| Search | Local build-generated index; no external search service |
## Visual reference
The theme adapts [Eldorado’s website](https://www.eldorado.gg/): near-black navigation, charcoal surfaces, gold `#ffc950` accents, light `#f6f6f6` backgrounds, and Lato type. Gold buttons use dark text; light-mode text links use a darker gold for contrast. Fonts are bundled locally.
The documentation uses original page artwork and a document icon, not marketplace imagery, commercial copy, or the official logo. Square panels follow the workspace’s existing design preference. This is a documentation workspace, not the public Eldorado marketplace.
The publication workflow follows the persistent-mount pattern in [corp-v1/portal](https://gitea.lego-cloud.eu/corp-v1/portal/src/branch/main/.gitea/workflows/pages.yml).