[dereuromark]

The documentation was one README that listed method names. This adds a VitePress site under docs/, built and deployed to GitHub Pages by .github/workflows/deploy-docs.yml on pushes to master. Setup and theme follow dereuromark/cakephp-decimal, with a blue palette and its own logo.

Target URL: https://php-collective.github.io/decimal-object/

Pages

• Guide: Installation, Getting started, Creating decimals, Arithmetic, Precision and scale, Rounding, Comparison and checks, Conversion
• Reference: API (every public method, constants, exceptions), Integrations, Alternatives, Upgrading

Every example output was produced by running the code against this branch.

Things the old docs did not mention and the new ones do:

• A scale passed to the constructor cuts off digits, and a larger scale is recorded without padding the string.
• divide(), pow() and sqrt() cut off at the scale and do not round.
• Scientific notation from untrusted input can expand to a very large string.
• == on two objects does not compare values.
• The 1.x limits that Apply the behavior changes held back from 1.x #23 lifts in 2.0: a scale of 0 is ignored, ROUND_FLOOR and ROUND_CEIL round to whole numbers only, unsupported modes round half up, and mod() uses the scale of the left operand.

Other changes

• Root README shortened to a summary with links into the site. The contributing notes moved there from docs/README.md.
• Alternatives and the php-decimal comparison moved over from the wiki. The wiki link is gone from the README; the wiki page itself can be removed or pointed at the site after the merge.
• docs/ is export-ignored so it stays out of Composer installs.

Before merging

GitHub Pages is not enabled on this repository yet. It needs Settings > Pages > Source set to "GitHub Actions", otherwise the deploy job fails.

docs/reference/upgrading.md is headed "From 1.3" and does not name the next version. It ends with a "Coming in 2.0" table for the changes in #23.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.65%. Comparing base (5fd1e0a) to head (5d2d496).

Additional details and impacted files

@@            Coverage Diff            @@
##             master      #22   +/-   ##
=========================================
  Coverage     95.65%   95.65%           
  Complexity      114      114           
=========================================
  Files             1        1           
  Lines           230      230           
=========================================
  Hits            220      220           
  Misses           10       10           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.