Skip to content

Link the Decimal object documentation from the main navigation - #18

Merged
dereuromark merged 1 commit into
masterfrom
docs/decimal-object-links
Oct 11, 2026
Merged

dereuromark merged 1 commit into
masterfrom
docs/decimal-object-links

Conversation

@dereuromark

Copy link
Copy Markdown
Owner

The only pointer to the Decimal object's own documentation was the last line of the Conversion reference page. Arithmetic, rounding and comparison are all documented upstream, so that link deserves a visible place.

  • Top navigation: "Decimal API"
  • Sidebar: "Decimal object API"
  • Home page: the "Decimal arithmetic" card links to the upstream docs
  • Getting started: a tip box with links to arithmetic, rounding, scale and the API
  • Conversion page and README: existing links now point at the documentation site

Draft until php-collective/decimal-object#22 is merged and GitHub Pages is enabled there. Until then https://php-collective.github.io/decimal-object/ returns 404.

The only pointer to the value object's own documentation was the last
line of the conversion reference. Arithmetic, rounding and comparison
all live in php-collective/decimal-object, so readers looking for those
had no visible way to get there.

Adds the link to the top navigation, the sidebar, the home page feature
card and a tip box in Getting started, and points the existing links at
the new documentation site.
@dereuromark dereuromark added the documentation Improvements or additions to documentation label Oct 11, 2026
@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 6a72f4a6-b589-47c0-b71e-d8bef8a27c6c

📥 Commits

Reviewing files that changed from the base of the PR and between 31ad793 and ee7a182.


📒 Files selected for processing (5)
  • README.md
  • docs/.vitepress/config.ts
  • docs/guide/getting-started.md
  • docs/index.md
  • docs/reference/conversion.md

 _________________________________________________________________________________________________________
< If a system is to serve the creative spirit, it must be entirely comprehensible to a single individual. >
 ---------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR

🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@dereuromark
dereuromark marked this pull request as ready for review October 11, 2026 16:34
@dereuromark
dereuromark merged commit 0198787 into master Oct 11, 2026
19 checks passed
@dereuromark
dereuromark deleted the docs/decimal-object-links branch October 11, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant