1.9 KiB
title, description, slug
| title | description | slug |
|---|---|---|
| How to update and publish the site | Preview documentation changes, validate them, and publish through Gitea Actions. | /maintain |
What you need
Node.js 22 or later, pnpm 10.15.1, and write access to the private documentation repository.
Preview locally
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
Include title and description frontmatter. Place each page in its owning section and add its document ID to that section’s sidebar:
| Section | Content directory | Sidebar configuration |
|---|---|---|
| Organization | docs/organization/ |
sidebars/organization.ts |
| Strategy | docs/strategy/ |
sidebars/strategy.ts |
| Contribution | docs/contribution/ |
sidebars/contribution.ts |
| Portal maintenance and reference | docs/core/ |
sidebars.ts |
Keep these content roots disjoint. Preserve existing URLs when moving pages. Specific AI initiatives and organizational reporting lines remain subject to agreement.
Validate the change
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. Pages access follows the platform’s existing authentication policy; a sign-in redirect is not a failed build.