Implement Lightweight Documentation Website

[runatyr1]

Implement Lightweight Documentation Website

Objective

Implement a lightweight documentation website that automatically syncs with GitHub repository content and supports MD/MDX files, with TLS encryption and proper ingress configuration.

Requirements

• Automatic sync with GitHub repository (docs folder)
• Support for MD and MDX files
• Lightweight alternative to Docusaurus
• TLS encryption using Let's Encrypt staging
• Accessible at pietro.top/docs

Technical Specifications

• Use MkDocs with Material theme for lightweight documentation
• Configure GitHub webhook for automatic updates
• Deploy using Helm chart
• Configure ingress with TLS and proper path routing
• Maintain existing documentation structure

Acceptance Criteria

• 1. Documentation site deploys successfully with all content from GitHub
• 2. Automatic sync works when changes are pushed to main branch
• 3. All MD/MDX files render correctly with proper formatting
• 4. TLS certificate is properly provisioned through cert-manager
• 5. Site is accessible at pietro.top/docs with proper routing
• 6. Navigation mirrors GitHub folder structure
• 7. Performance metrics show improved load times compared to Docusaurus

Notes

• Consider implementing caching later for improved performance

[runatyr1]

Progress has been made, still a few issues to solve, merging changes so far

Status:

user1@debian..:devops-cluster ✓$ k logs pod/docs-website-prod-548d6d4fc6-n6v7b
Syncing docs content...
Building documentation site...

> docs-site@0.0.1 build
> astro build

▶ Astro collects anonymous usage data.
  This information helps us improve Astro.
  Run "astro telemetry disable" to opt-out.
  https://astro.build/telemetry

05:26:15 [content] Syncing content
05:26:15 [content] Synced content
05:26:15 [types] Generated 371ms
05:26:15 [build] output: "static"
05:26:15 [build] directory: /app/docs-site/dist/
05:26:15 [build] Collecting build info...
05:26:15 [build] ✓ Completed in 415ms.
05:26:15 [build] Building static entrypoints...
05:26:19 [vite] ✓ built in 3.55s
05:26:19 [build] ✓ Completed in 3.68s.

 generating static routes 
05:26:19 ▶ src/pages/docs/docs/README.md
05:26:19   └─ /docs/docs/README/index.html (+14ms) 
05:26:19 ▶ src/pages/index.astro
05:26:19   └─ /index.html (+6ms) 
05:26:19 ✓ Completed in 40ms.

05:26:19 [build] 2 page(s) built in 4.16s
05:26:19 [build] Complete!
Updating nginx content...
cp: can't create directory '/usr/share/nginx/html/docs': No such file or directory
cp: can't create '/usr/share/nginx/html/favicon.svg': No such file or directory
cp: can't create '/usr/share/nginx/html/index.html': No such file or directory