Files
documentation/README.md
jarvis-at-skic 9ad62a2ed6
Build and publish Eldorado documentation / build (pull_request) Successful in 29s
feat: add section navigation and embedded Archify diagrams
2026-10-02 10:33:55 +00:00

37 lines
2.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Eldorado Powered By AI
A Docusaurus workspace for AI strategy and direction for Eldorado. Specific initiatives, priorities, and the roadmap remain to be defined.
- Site: https://pages.apps.lego-cloud.eu/eldorado-v1/documentation/
- Repository: https://gitea.lego-cloud.eu/eldorado-v1/documentation (private)
- Channel: https://discord.com/channels/1518726359512387766/1555510466904727622
## Development
Use Node.js 22+ and pnpm 10.15.1.
```sh
pnpm install --frozen-lockfile
pnpm start
pnpm verify
pnpm typecheck
pnpm build
pnpm verify:build
```
## CI and publication
Pull requests validate only. Pushes to `main` validate, build, and publish to the persistent runner mount at `/gondor-v1-gitea-pages/eldorado-v1/documentation/`, following `corp-v1/portal`. Publication fails if that mount is unavailable. The Pages platform controls user authentication independently of repository visibility. No infrastructure or authentication changes are required.
After publication, verify the exact commit’s Actions task and deployed page body; an OAuth redirect is not content verification. Future changes should use pull requests. Never commit credentials or edit generated `build/` output.
## Sections and diagrams
Top-level sections are Organization, Strategy, and Contribution, each with an independent sidebar. The first Organization page is Structure and contains an explicitly illustrative organization chart, not confirmed Eldorado reporting lines.
Archify 3.0.1 is vendored under `vendor/archify/` from commit `d5a1333d7447c866a765adac7d4d062f2f02e4d2`. MIT and third-party notices are preserved. `diagrams/` holds editable JSON; `pnpm diagrams:build` validates and generates local standalone viewers before every site build. The iframe is sandboxed without same-origin permission. See `docs/contribution/diagrams.md` for capability analysis, authoring, boundaries, and upgrade procedure.
## Design
Inspired by https://www.eldorado.gg/: Lato, near-black navigation, charcoal, gold `#ffc950`, light panels, bold headings. Original documentation artwork and square panels; no official marketplace assets or business claims. See `docs/core/reference.md`.