Skip to content

Conversation

@marlonicus
Copy link
Contributor

@marlonicus marlonicus commented Oct 15, 2025

Documentation Improvements

This PR contains comprehensive improvements and updates to the project documentation, as well as cleanup of outdated code and packages.

💡 To check these changes:

📚 Documentation Updates

Library version

  • Local reference: The docs now reference the local version of the library, which allows us to keep the docs in lock-step sync with the library API.

API Documentation Enhancements

  • Hooks Documentation: Significantly expanded the hooks documentation with detailed examples and usage patterns
  • Equality Checks: Added a new section on creating custom equality checkers and improved the docs on the rest of the checkers
  • Fast Components: Improvements to the fast-components docs
  • Quick Reference Sections: Added quick reference sections throughout the docs for easier navigation
  • Cleanup: Removed references to removed dom-components package

🧹 Code Cleanup

Package Removal

  • Removed @react-facet/spring package

Code Fixes

  • Fixed incorrect equality checkers in core/src/equalityChecks.ts

Dependency Updates

  • Updated docs/package.json dependencies to reference latest versions
  • Added TypeScript configuration for docs (docs/tsconfig.json) to get docusaurus/twoslash happy
  • Updated yarn.lock files to reflect dependency changes

@marlonicus marlonicus force-pushed the docs-improvements-2025-10-15 branch from 1dede84 to 91774a5 Compare October 15, 2025 18:32
@marlonicus marlonicus force-pushed the docs-improvements-2025-10-15 branch from 014e1b1 to 8c0285d Compare October 16, 2025 09:35
Copy link
Contributor

@Bahamoe Bahamoe left a comment

Choose a reason for hiding this comment

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

Great stuff!

@marlonicus marlonicus merged commit 1c10485 into main Oct 17, 2025
25 of 27 checks passed
@marlonicus marlonicus deleted the docs-improvements-2025-10-15 branch October 17, 2025 09:05
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.

2 participants