Add a list of external help and research documents #388
Conversation
WalkthroughThe pull request introduces significant updates to the Changes
Assessment against linked issues
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
doc/research/README.md (2)
10-17: Consider maintaining consistent link patterns.
While the links are functional, there's an inconsistency in the linking pattern:
- PAF22 and PAF23 link to directories (
./paf22/,./paf23/) - PAF24 links directly to README.md (
./paf24/README.md)
Consider using consistent directory links for all years.
-[PAF24](./paf24/README.md)
+[PAF24](./paf24/)49-54: Consider adding brief descriptions for general resources.
While the general resources section provides valuable links, it would be more helpful to add brief descriptions explaining what users can expect to find in each resource, similar to how the CARLA-specific resources are documented.
Example enhancement:
-[Awesome Autonomous Vehicles](https://github.com/manfreddiaz/awesome-autonomous-vehicles)
+[Awesome Autonomous Vehicles](https://github.com/manfreddiaz/awesome-autonomous-vehicles)
+ - A curated list of autonomous driving resources, papers, and frameworks.📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- doc/research/README.md (1 hunks)
- doc/research/paf24/README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/research/README.md
[grammar] ~28-~28: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... leaderboard entries. - Global Route Understanding - Understand how the global route is generated. - ...
(REPEATED_VERBS)
[duplication] ~32-~32: Possible typo: you repeated a word
Context: ...tages, and limitations. - Leaderboard Repository - [Repository Link](https://github.com/carla-simulato...
(ENGLISH_WORD_REPEAT_RULE)
doc/research/paf24/README.md
[uncategorized] ~1-~1: Do you mean "riserts"?
Context: # PAF24 Research
(RESEARCH)
🔇 Additional comments (3)
doc/research/README.md (3)
3-9: Well-structured introduction and table of contents!
The introduction clearly states the purpose of the folder, and the table of contents provides an organized overview of the document structure.
18-48: Excellent compilation of CARLA-specific resources!
The CARLA-specific section is well-structured with detailed descriptions and helpful context for each resource. The hierarchical organization makes it easy to navigate and understand the purpose of each link.
🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... leaderboard entries. - Global Route Understanding - Understand how the global route is generated. - ...
(REPEATED_VERBS)
[duplication] ~32-~32: Possible typo: you repeated a word
Context: ...tages, and limitations. - Leaderboard Repository - [Repository Link](https://github.com/carla-simulato...
(ENGLISH_WORD_REPEAT_RULE)
24-54: Verify the accessibility of external links.
Let's ensure all external links are accessible.
✅ Verification successful
All external links are accessible
All URLs in the markdown file were successfully verified and are accessible. The curl commands completed without any failure warnings, indicating that each link returns a valid HTTP response.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Extract and verify all external links from the markdown file
# Note: This script will help identify any broken links
# Extract URLs and check their accessibility
grep -o 'https://[^)]*' doc/research/README.md | while read -r url; do
echo "Checking: $url"
curl --output /dev/null --silent --head --fail "$url" || echo "WARNING: Failed to access $url"
done
Length of output: 4956
🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... leaderboard entries. - Global Route Understanding - Understand how the global route is generated. - ...
(REPEATED_VERBS)
[duplication] ~32-~32: Possible typo: you repeated a word
Context: ...tages, and limitations. - Leaderboard Repository - [Repository Link](https://github.com/carla-simulato...
(ENGLISH_WORD_REPEAT_RULE)
Fixes #356
Description
Add links to external help documents
Fixes # 356
Type of change
added Documentation
Does this PR introduce a breaking change?
no
Most important changes
added general research links
Summary by CodeRabbit
New Features
Documentation