fix: correct "Edit this page" GitHub URL path

[himanshujays29]

Fixes #500

Changes done:

• Fixed incorrect “Edit this page” GitHub URLs by removing the duplicated docs/docs segment
• Ensured the generated edit links correctly map to the actual Markdown file paths in the repository
• Verified the fix applies consistently across all documentation pages

---

Screenshots:

Before (Incorrect GitHub edit link – contains docs/docs):

After (Correct GitHub edit link – proper path):

---

Preview Link(s):

• https://docs.circuitverse.org/

✅️ 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 the "Edit on GitHub" link destination to direct users to the repository root instead of a subdirectory.

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

[coderabbitai]

Walkthrough

The PR updates the EditOnGithubPlugin configuration in two files, changing the base GitHub path from https://github.com/CircuitVerse/CircuitVerseDocs/blob/master/docs/ to https://github.com/CircuitVerse/CircuitVerseDocs/blob/master/. This modification alters the target destination for the "Edit this page" links, adjusting the GitHub URLs that users are directed to when editing documentation content.

🚥 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 'fix: correct "Edit this page" GitHub URL path' directly describes the main change: correcting the GitHub URL path for edit links.
Linked Issues check	✅ Passed	The PR directly addresses issue #500 by removing the duplicated 'docs' segment from GitHub edit URLs, changing paths from 'docs/docs' to 'docs' in both config files.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to fixing the edit link URL issue; no unrelated modifications are present in the changeset.
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 4894d2c.

📒 Files selected for processing (2)

• docs/index.html
• docusaurus.config.js

🔇 Additional comments (2)

docs/index.html (1)

87-87: Fix correctly removes the duplicated docs/ segment.

The change properly addresses issue #500 by removing the trailing docs/ from the base URL, so the plugin-generated paths will now correctly resolve to .../master/docs/chapter1/... instead of .../master/docs/docs/chapter1/....

One observation: this URL uses blob/master/ while the corresponding Docusaurus config uses edit/master/. Using blob shows the file in read-only view, whereas edit takes users directly to GitHub's edit interface. Please verify this is intentional behavior for the docsify-edit-on-github plugin, or consider changing to edit/master/ for a more direct editing experience.

docusaurus.config.js (1)

30-30: LGTM!

The change correctly removes the duplicated docs/ segment from the edit URL. Docusaurus will append the relative path from the docs root (e.g., docs/chapter1/2keyfeatures.md), resulting in the expected URL format: .../edit/master/docs/chapter1/2keyfeatures.md.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[himanshujays29]

Hey @Nihal4777, Please have a look.

[Nihal4777]

Thanks @himanshujays29 for the fix. Closing this as it is fixed in #501.