Skip to content

fix: Update deployment workflow to build Docusaurus docs#226

Merged
ibrahimcesar merged 1 commit intomainfrom
fix/update-docs-deployment-workflow
Nov 20, 2025
Merged

fix: Update deployment workflow to build Docusaurus docs#226
ibrahimcesar merged 1 commit intomainfrom
fix/update-docs-deployment-workflow

Conversation

@ibrahimcesar
Copy link
Copy Markdown
Owner

@ibrahimcesar ibrahimcesar commented Nov 20, 2025

Summary

Updates the GitHub Pages deployment workflow to build and deploy the new Docusaurus documentation site instead of the old standalone demo that was removed.

Changes

Deployment Workflow Updates

  • Renamed workflow: "Deploy Demo to GitHub Pages" β†’ "Deploy Docs to GitHub Pages"
  • Updated build process: Now builds docs from docs/ directory instead of demo/
  • Changed artifact path: demo/out β†’ docs/build
  • Added automatic trigger: Deploys on pushes to main that affect docs/** or the workflow file
  • Removed version input: Simplified workflow dispatch since docs always use local library build
  • Updated npm cache: Now caches docs/package-lock.json
  • Updated messaging: All deployment summaries now reference documentation instead of demo

GNU Terry Pratchett Tribute

  • Added X-Clacks-Overhead: GNU Terry Pratchett header to all documentation pages
  • Created custom Docusaurus plugin to inject the meta tag
  • "A man is not dead while his name is still spoken." - Read more: http://www.gnuterrypratchett.com/

Context

The standalone Next.js demo was replaced with a comprehensive Docusaurus documentation site in recent PRs. The deployment workflow was still trying to build the old demo structure, which no longer exists.

Testing

  • βœ… Workflow syntax is valid
  • βœ… All paths reference existing directories
  • βœ… npm cache configuration points to correct lock file
  • βœ… Docs build successfully with new plugin
  • βœ… X-Clacks-Overhead header verified in built HTML

Related


Ready to merge - This fixes the broken deployment workflow and adds a tribute header.

The standalone demo was removed and replaced with a comprehensive
Docusaurus documentation site. This updates the GitHub Pages
deployment workflow to build and deploy the docs instead.

Changes:
- Renamed workflow from "Deploy Demo" to "Deploy Docs"
- Updated build process to use docs directory
- Changed artifact path from demo/out to docs/build
- Added automatic trigger on pushes to main that affect docs
- Removed outdated version input parameter
- Updated all messaging to reflect documentation deployment
- Added npm cache path for docs dependencies
@ibrahimcesar ibrahimcesar merged commit fa4d9f1 into main Nov 20, 2025
6 of 7 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

size-limit report πŸ“¦

Path Size
ES Module 3.08 KB (0%)
CommonJS 3.08 KB (0%)
CSS 1.22 KB (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant