Skip to content

feat: add dictionary to docs page#23

Open
Uri-Tauber wants to merge 1 commit into
crosspoint-reader:masterfrom
Uri-Tauber:add-dict-docs
Open

feat: add dictionary to docs page#23
Uri-Tauber wants to merge 1 commit into
crosspoint-reader:masterfrom
Uri-Tauber:add-dict-docs

Conversation

@Uri-Tauber

Copy link
Copy Markdown
Member

It will fails to load right now, since the documentation is fetched from master, and dictionary support is only on develop right now.
Merge after release 1.5.0.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation sidebar now includes a “Dictionary” item sourced from docs/dictionary.md, making it available through the existing document selection and hash routing.

Changes

Documentation navigation

Layer / File(s) Summary
Add Dictionary documentation entry
src/pages/DocsPage.jsx
Adds the Dictionary label and markdown download URL to the documentation file list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: itsthisjustin

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding the dictionary entry to the docs page.
Description check ✅ Passed The description is related to the PR and mentions the docs loading/deploy timing issue described in the objectives.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/DocsPage.jsx`:
- Line 53: Update the Dictionary entry in the DocsPage document list to use a
RAW_BASE ref where docs/dictionary.md exists, or remove/gate the entry until
that file is available; ensure selecting Dictionary no longer targets a 404 URL.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 700b5119-7095-4855-b04d-18981435275f

📥 Commits

Reviewing files that changed from the base of the PR and between b7c3433 and 66794a1.

📒 Files selected for processing (1)
  • src/pages/DocsPage.jsx

Comment thread src/pages/DocsPage.jsx
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