Skip to content

Conversation

@Prince-ES
Copy link

@Prince-ES Prince-ES commented Nov 9, 2025

Fix broken internal link to K-Maps in canonical.md

Fixes #

Ref #

Changes done:

  • Fixed broken internal link to K-Maps page in docs/logic-design/canonical.md
  • Replaced outdated absolute URLs with working relative path ./kmaps
  • Left "NAND gate method" as plain text since no corresponding page exists

Screenshot:

Before: Clicking “Karnaugh-map” opened a 404 error page.
Screenshot 2025-11-09 185819

After: Clicking “Karnaugh-map” correctly opens the K-Maps page.
Screenshot 2025-11-09 185842

Preview Link(s):

http://127.0.0.1:4000/docs/logic-design/canonical.html (tested locally)

✅️ 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 the link(s) for all the pages changed/updated from the checks tab after checks complete)
  • Tried Squashing the commits into one

Summary by CodeRabbit

  • Documentation
    • Updated reference links in the logic design documentation to improve navigation to related resources.

@coderabbitai
Copy link

coderabbitai bot commented Nov 9, 2025

Walkthrough

Updated two Karnaugh-map reference URLs in the documentation file from /docs/maps.html to /docs/logic-design/kmaps to reflect revised link paths.

Changes

Cohort / File(s) Change Summary
Karnaugh-map Reference Links
docs/logic-design/canonical.md
Updated two K-map reference URLs from /docs/maps.html to /docs/logic-design/kmaps

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: fixing a broken internal link to K-Maps in canonical.md, which matches the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f8cb565 and 247e512.

📒 Files selected for processing (1)
  • docs/logic-design/canonical.md (1 hunks)
🔇 Additional comments (2)
docs/logic-design/canonical.md (2)

367-368: Verify consistency with PR description regarding NAND gate method link.

The PR description states: "Left the text 'NAND gate method' as plain text because no corresponding page exists," but Line 368 still contains a hyperlink to https://learn.circuitverse.org/docs/nand_gate_method.html. Please clarify whether:

  1. The NAND gate method link should have been converted to plain text (no link), or
  2. The PR description was describing an alternative approach that wasn't ultimately implemented.

If the link should be removed, apply this diff:

- 1. The [NAND gate method](https://learn.circuitverse.org/docs/nand_gate_method.html).
+ 1. The NAND gate method.

367-367: Confirm the K-map URL uses the appropriate link format.

The PR description mentions replacing outdated absolute URLs with a working relative path ./kmaps, but Line 367 contains an absolute URL: https://learn.circuitverse.org/docs/logic-design/kmaps. Verify whether:

  1. Absolute URLs (as currently shown) are the intended format for internal links in this documentation, or
  2. Relative paths should be used instead (as suggested in the PR description).

If relative paths are preferred, apply this diff:

- 1. The [Karnaugh-map](https://learn.circuitverse.org/docs/logic-design/kmaps) or K-map method.
+ 1. The [Karnaugh-map](./kmaps) or K-map method.

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.

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