Skip to content

Switched Docs Site to Modular Template and Simplified Documentation Build

Choose a tag to compare

released this 23 Jul 18:26
· 61 commits to working since this release

This release focuses on migrating Fjell HTTP API's documentation system to a unified, modular approach based on the shared @fjell/docs-template, as described in the release focus of consolidating documentation, improving maintainability, and standardizing navigation and appearance across all docs.

Improvements

  • Replaced the custom React and CSS-based documentation app in docs/src/ with the modular, configuration-driven @fjell/docs-template system
  • Added a new docs.config.ts file defining docs branding, navigation, sections, and assets to copy into the public site directory
  • Updated docs/src/main.tsx to initialize the standardized docs app via DocsApp and imported the shared CSS theme
  • Added type definition files for integrating the docs template (types.d.ts, updates to vite-env.d.ts)
  • Simplified documentation scripts so that serving/building docs always copies Markdown sources before building or previewing

Removals & Refactoring

  • Deleted all local documentation UI code: removed App.tsx, manual CSS (App.css), and local test files from docs/src/, eliminating custom Markdown rendering, navigation, theming, and test logic
  • Removed no longer needed dependencies from the docs package: react-markdown, react-syntax-highlighter, and remark-gfm are now transitively provided via the docs template
  • Cleaned up and clarified markdown files in examples/ and documentation roots, removing redundant headers and comments for uniform display in the new template
  • Adjusted documentation build scripts and the root package to support modular docs workflows (build, serve, preview, test)

Dependency Updates

  • Bumped @fjell/logging dependency to 4.4.14 (previously 4.4.13)
  • Bumped @swc/core devDependency to 1.13.2 (was 1.13.1)

Key Impact

  • All project documentation is now managed through config and Markdown—future updates should be performed via configuration and Markdown files
  • Documentation navigation, sections, and styling are now consistent across the Fjell ecosystem and no longer require local React or style maintenance
  • Packaging and source code for the HTTP API client itself is unaffected; only the documentation build, navigation, and site appearance are updated

No changes were made to API behavior, types, or runtime code. This release strictly modernizes and simplifies the documentation experience.