Skip to content

Comments

Docs site#63

Merged
AndrewRedican merged 77 commits intomainfrom
docs-site
Feb 22, 2026
Merged

Docs site#63
AndrewRedican merged 77 commits intomainfrom
docs-site

Conversation

@AndrewRedican
Copy link
Owner

@AndrewRedican AndrewRedican commented Feb 19, 2026

Description

This PR introduces the comprehensive documentation site (docs-site) with auto-generated API reference documentation for all libraries, alongside significant build improvements to bundle libraries as self-contained zero-dependency packages.

Related Issue

Fixes #63

Type of Change

✨ Feature | 📝 Docs | ♻️ Refactor | 🔧 Build/Config

Changes Made

Documentation Site (docs-site)

  • Added API reference components: search/filter, copy button, function signature display, parameter list, type definitions, module grouped view
  • Created new library documentation pages for all utils packages (data, function, immutable-api, json, list, random-generator, string, time, ui)
  • Enhanced generate-docs.ts script for comprehensive API doc generation
  • Added validate-links.ts script for link validation
  • Updated docs-loader and content utilities

Build System Improvements

  • Bundled ESM and CJS output as self-contained zero-dependency packages for:
    • lib-nexus, lib-network-protocol, lib-cryptography, lib-logging
    • lib-state-machine, lib-list-utils, lib-random-generator-utils, lib-ui-utils
  • Updated build configuration for lib-data-utils, lib-json-utils, lib-immutable-api-utils, lib-function-utils, lib-time-utils, lib-string-utils
  • Enhanced tools/package executor with optional bundling support

New Library

  • Added lib-json-utils to replace external dependencies (jsonschema, to-json-schema)
  • Complete code coverage for lib-json-utils

CI/CD Simplification

  • Consolidated 13 individual library CI workflows into unified ci-libraries.yml and ci-plugins.yml
  • Simplified main CI workflow
  • Added sequential execution and CI mode usage on pipeline

Documentation Updates

  • Added docs-site links to all library README files
  • Removed bundlephobia badges from all library READMEs
  • Updated README, CONTRIBUTING.md, FUNDING.md
  • Updated documentation roadmap

Dependency Updates

  • Migrated to Nx 22.4.5
  • Dropped @swc dependencies
  • Removed unused eslint-config-next dependency
  • Updated lefthook, lodash, minimatch versions
  • Patched mermaid for security vulnerability

Testing

  • Unit tests maintained/added for lib-json-utils with complete coverage
  • Existing library tests pass after build configuration changes
  • Documentation generation scripts tested locally

Screenshots/Videos

N/A - Documentation site preview available via Vercel deployment

Checklist

  • I have performed a self-review of my code
  • I have added/updated tests as needed
  • I have updated relevant documentation
  • I have used npm run commit for conventional commit messages

Additional Notes

Build Impact: Libraries now produce self-contained bundles, eliminating the need for consumers to install peer dependencies.

Breaking Changes: None - all changes are backward compatible.

Performance: lib-json-utils regex performance issues were fixed.

Files Changed: 192 files with approximately 14,648 insertions and 13,986 deletions across the codebase.


📝 CLA Requirement

By submitting this pull request, you acknowledge that:

  • You have read and agree to sign our Contributor License Agreement (CLA)
  • The CLA Assistant bot will automatically check your signature status
  • If you haven't signed yet, the bot will provide instructions in the comments
  • By signing, you grant the project maintainer exclusive rights to your contributions

For more information, see our Contributing Guide.


Thank you for contributing to hyperfrontend! 🚀

@vercel
Copy link

vercel bot commented Feb 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-site Ready Ready Preview, Comment Feb 22, 2026 5:21pm

Request Review

@nx-cloud
Copy link

nx-cloud bot commented Feb 19, 2026

View your CI Pipeline Execution ↗ for commit 3261bc6

Command Status Duration Result
nx version lib-time-utils --skipCommit --skipTag ✅ Succeeded <1s View ↗
nx version lib-string-utils --skipCommit --skipTag ✅ Succeeded <1s View ↗
nx version lib-json-utils --skipCommit --skipTag ✅ Succeeded <1s View ↗
nx version lib-immutable-api-utils --skipCommit... ✅ Succeeded <1s View ↗
nx version lib-function-utils --skipCommit --sk... ✅ Succeeded <1s View ↗
nx version lib-list-utils --skipCommit --skipTag ✅ Succeeded <1s View ↗
nx version lib-ui-utils --skipCommit --skipTag ✅ Succeeded <1s View ↗
nx version lib-random-generator-utils --skipCom... ✅ Succeeded <1s View ↗
Additional runs (12) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2026-02-22 17:23:55 UTC

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a comprehensive documentation site with auto-generated API reference documentation, transforms the build system to produce self-contained zero-dependency library bundles, adds a new lib-json-utils library to replace external dependencies (jsonschema and to-json-schema), and consolidates 13 individual library CI workflows into unified workflows.

Changes:

  • Added docs-site with API reference components, navigation, and content utilities
  • Enhanced build system to bundle workspace dependencies as self-contained packages
  • Created lib-json-utils with JSON Schema validation and generation (100% test coverage)
  • Migrated from jsonschema and to-json-schema to @hyperfrontend/json-utils
  • Consolidated CI workflows and added sequential execution with parallel=1
  • Updated all library READMEs with docs-site links and removed bundlephobia badges
  • Updated dependencies (Nx 22.4.5, GitHub Actions, lefthook, minimatch, etc.)

Reviewed changes

Copilot reviewed 190 out of 192 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tsconfig.base.json Added path mapping for @hyperfrontend/json-utils
tools/package/src/executors/build/lib/types.ts Added bundleWorkspaceDeps configuration to ESM/CJS configs
tools/package/src/executors/build/lib/rollup-plugins.ts Enhanced plugins to support workspace dependency bundling
tools/package/src/executors/build/lib/package-json.ts Added logic to filter workspace dependencies from published package.json
tools/package/src/executors/build/lib/externals.ts Refactored external dependency handling for bundling mode
tools/package/src/executors/build/lib/config-esm.ts Updated ESM config to pass bundling parameters
tools/package/src/executors/build/lib/config-cjs.ts Updated CJS config to pass bundling parameters
tools/package/src/executors/build/lib/assets.ts Changed from async to sync glob operations
tools/package/src/executors/build/executor.ts Updated asset copying to synchronous
libs/utils/json/* New library with validation, generation, types, and comprehensive tests
libs/nexus/src/schema/validate/* Migrated from jsonschema to @hyperfrontend/json-utils
libs/network-protocol/src/lib/data/* Migrated from jsonschema/to-json-schema to @hyperfrontend/json-utils
libs/*/project.json Added bundleWorkspaceDeps: true to ESM/CJS configurations
libs/*/README.md Updated documentation links and removed bundlephobia badges
apps/docs-site/src/* New documentation site components and utilities
.github/workflows/* Consolidated library/plugin workflows, updated action versions
package.json Removed external dependencies, updated devDependencies
nx.json Added parallel: 1 and removed rollup plugin
jest.preset.cjs Fixed regex escaping in testPathIgnorePatterns
Files not reviewed (1)
  • apps/docs-site/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@AndrewRedican AndrewRedican merged commit 995629b into main Feb 22, 2026
19 checks passed
@AndrewRedican AndrewRedican deleted the docs-site branch February 22, 2026 17:27
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