Skip to content

Switch Documentation to npm and Streamline Build Scripts

Choose a tag to compare

released this 24 Jul 15:19
· 58 commits to working since this release

This release focuses on modernizing the documentation project's dependency management and aligning build processes with the broader Fjell ecosystem direction. The main goal is to standardize on npm for documentation tooling, simplify CI/CD workflows, and update dependencies to maintain compatibility and ease of maintenance.

Improvements

  • Migrated the documentation project from pnpm to npm:
    • Removed docs/pnpm-lock.yaml
    • Added docs/package-lock.json to enable npm as the default package manager for the docs
  • Updated documentation-related scripts (docs:dev, docs:build, docs:preview, docs:test) in the main package.json and within docs/package.json to use npm commands
  • Updated the copy-docs script to utilize npx copy-docs for better compatibility and maintainability
  • Revised the docs GitHub Actions workflow by removing unnecessary explicit pnpm/npm install steps—now, the workflow relies on previously installed dependencies and simply runs the docs build script
  • Simplified custom file copying logic and config:
    • Updated docs.config.ts to import the typed DocsConfig from @fjell/docs-template
    • Removed manual file copy rules for README.md and package.json that are now handled automatically or in the template/workflow
  • Upgraded documentation dependencies:
    • Bumped @fjell/docs-template in docs/package.json from 1.0.5 to 1.0.17

Dependency Updates

  • Main project @fjell/logging dependency updated to ^4.4.25 for improved compatibility across the Fjell ecosystem (no source code changes)

Notes to Developers

  • All documentation-related development and CI should now use npm
  • No changes to HTTP API source code or runtime behavior—these updates are focused entirely on tooling and documentation infrastructure
  • Consistent dependency versions and package management streamline future updates and troubleshooting across environments.