Skip to content

fix broken 'Edit this page' link#501

Merged
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
manash213cyber:fix-edit-page-link
Jan 31, 2026
Merged

fix broken 'Edit this page' link#501
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
manash213cyber:fix-edit-page-link

Conversation

@manash213cyber
Copy link
Copy Markdown
Contributor

@manash213cyber manash213cyber commented Jan 12, 2026

Fixes #500

Changes done:

  • Fixed incorrect "Edit this page" GitHub URLs that contained docs/docs

Screenshots:

N/A (No UI changes)

Preview Link(s):

Will be added after checks complete

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Sample preview link added (add a link from the checks tab after checks complete)
  • Tried Squashing the commits into one

Summary by CodeRabbit

  • Documentation
    • Updated "Edit this page" links in documentation to point to the repository root instead of the docs subfolder.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 12, 2026

Walkthrough

The docusaurus.config.js configuration file was updated to correct the edit URL path for documentation pages. Previously, the edit URL included an additional 'docs/' subdirectory in the path, resulting in malformed GitHub URLs when users clicked 'Edit this page' links. The configuration now points to the repository root edit path instead of the docs subpath, aligning the generated URLs with the actual file locations in the repository.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change—fixing the broken 'Edit this page' link configuration in docusaurus.config.js, which directly addresses the root cause identified in the PR objectives.
Linked Issues check ✅ Passed The PR directly fixes issue #500 by removing the duplicated 'docs/' segment from the edit URL configuration, changing it from 'docs/' to root path, which resolves the incorrect GitHub URLs.
Out of Scope Changes check ✅ Passed The change is limited to a single configuration file modification directly addressing the reported issue, with no unrelated changes present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d6c67a3 and 16dce86.

📒 Files selected for processing (1)
  • docusaurus.config.js
🔇 Additional comments (1)
docusaurus.config.js (1)

30-30: LGTM! This correctly fixes the duplicated docs/docs path issue.

The change removes the extraneous docs/ segment from the editUrl. Docusaurus automatically appends the relative path from the docs directory (e.g., docs/chapter1/file.md), so pointing to the repository root ensures the generated URLs match the actual file locations.


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 and usage tips.

Copy link
Copy Markdown
Member

@Nihal4777 Nihal4777 left a comment

Choose a reason for hiding this comment

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

Thanks @manash213cyber.

@Nihal4777 Nihal4777 merged commit d9b5b4d into CircuitVerse:master Jan 31, 2026
8 checks passed
@manash213cyber
Copy link
Copy Markdown
Contributor Author

Thanks for the review and merge!

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.

🐞 Bug: “Edit this page” links point to incorrect GitHub paths across documentation

2 participants