Documentation (Astro Starlight)
Overview
Section titled “Overview”This service hosts the homelab documentation. It is a static site built with Astro Starlight that follows a “Docs as Code” philosophy. It was chosen for its excellent performance, modern look, and ease of maintenance using Markdown files.
This service does not expose any local ports on the server as it is hosted as a static site.
External Access
Section titled “External Access”| Access Method | URL |
|---|---|
| Public Web | https://docs-home.javiersc.com |
[!NOTE] Unlike other services, the documentation is hosted on Cloudflare Pages to save local server resources and ensure high availability even if the local server is down.
Secrets
Section titled “Secrets”This service does not require runtime authentication credentials. The deployment is managed via a GitHub integration with Cloudflare.
Backup
Section titled “Backup”This service is stateless and managed as code. The source of truth is the GitHub repository:
https://github.com/JavierSegoviaCordoba/homelabBackups of the infrastructure configuration (the .nix files) are handled separately via the Restic backup service.
Configuration
Section titled “Configuration”The documentation is deployed via Cloudflare Pages.
- Build Command:
npm run build - Output Directory:
dist - Automatic Deployment: Enabled on every
git pushto themainbranch.
Troubleshooting
Section titled “Troubleshooting”Changes not appearing
Section titled “Changes not appearing”Symptom: You pushed a change to GitHub but the website doesn’t show it.
Cause: The Cloudflare Pages build might have failed or is still in progress.
Solution:
- Check the build status in the Cloudflare Dashboard under Workers & Pages.
- Ensure
package-lock.jsonis consistent withpackage.json.