docs: fix broken markdown links and add lychee config#2114
Conversation
Up to standards ✅🟢 Issues
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis pull request corrects a malformed heading in documentation and configures Lychee for link checking. The documentation fix addresses an incorrectly nested heading marker, while the new Lychee configuration defines URL exclusion patterns and request parameters to reduce false positives from known broken links. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerLet us write the prompt for your AI agent so you can ship faster (with fewer bugs). View plan for ticket: ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 32f11e8c-1756-4847-b983-52c841b39f44
📒 Files selected for processing (4)
.github/workflows/cron-check-broken-links.yml.lychee.tomldocs/discord.mddocs/sdk_developers/training/network_and_client.md
|
@tannaya7, the pre-commit checks are failing you can add the pre-commit by following the docs below |
|
@manishdait could you help to create a good first isssue to expand the set up in the templates to enable the pre commits? |
Yes |
|
@tannaya7, one of your commit is missing the signoff you can fix it by running |
exploreriii
left a comment
There was a problem hiding this comment.
@tannaya7 this is good but cannot merge due to your signing
note one commit is not GPG key signed
you need all of them to be DCO+GPG key signed
i recommend
git reset --soft HEAD~14
recommit
git commit -S -s -m "chore: your message"
git push --force
Please follow the guide in the issue carefully.
47939e5 to
1d60094
Compare
Signed-off-by: tannaya7 <tannayasupriya157@gmail.com>
1d60094 to
a619f7f
Compare
Description:
Fixed broken markdown links detected by the scheduled link checker. Changes include:
docs/discord.mdby removing the invalid deep linkdocs/sdk_developers/training/network_and_client.md.lychee.tomlconfiguration file to exclude intentional placeholder URLs from link checking.github/workflows/cron-check-broken-links.ymlto reference the new config fileRelated issue(s):
Fixes #2050
Notes for reviewer:
rebasing.mdfix was not needed as the file no longer exists in the repo.lychee.tomlinstead of being modifiedChecklist