docs: fix broken link to contribution guidelines in onboarding docs#2291
docs: fix broken link to contribution guidelines in onboarding docs#2291Prajwalwho wants to merge 1 commit intoasyncapi:masterfrom
Conversation
Prajwalwho
requested review from
asyncapi-bot-eve,
bandantonio,
derberg and
thulieblack
as code owners
📝 WalkthroughWalkthroughMultiple documentation files were updated to reflect a directory restructuring where contribution guidelines are relocated into a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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 |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Fix all issues with AI agents
In `@docs/000-onboarding/docs-onboarding-checklist.md`:
- Around line 15-16: The markdown link for "technical writer contributor
responsibilities" is split across two lines; update the checklist item so the
URL inside the parentheses is on a single line (remove the newline between
"../community/" and
"010-contribution-guidelines/technical-writer-contributor-responsibilities")
ensuring the entire URL sits on one line within the parentheses.
- Around line 17-18: The Markdown link for "prerequisite knowledge topics" is
broken across two lines; update the line containing [prerequisite knowledge
topics](../community/010-contribution-guidelines/prerequisite-knowledge) so the
entire URL appears on a single line inside the parentheses (remove the newline
and join the path) to ensure correct rendering.
- Around line 21-22: Update the malformed Markdown links that reference a
non-existent ../community/ subdirectory: replace occurrences of
"../community/010-contribution-guidelines/git-workflow" with the correct
relative path "../010-contribution-guidelines/git-workflow" and ensure each link
(the three affected links referencing the "AsyncAPI git workflow" /
"contribution guidelines" checklist items) is written on a single line as a
standard Markdown link so it renders correctly.
In `@docs/000-onboarding/maintainer-guide.md`:
- Around line 49-50: The link in maintainer-guide.md was changed to include a
non-existent community/ segment
("../community/010-contribution-guidelines/git-workflow") which causes a broken
link; revert the link target to the existing path
("../010-contribution-guidelines/git-workflow") or move the
contribution-guidelines files into docs/community/010-contribution-guidelines
and update all references accordingly so that references like
"../community/010-contribution-guidelines/git-workflow" point to an actual file;
update the link in the maintainer-guide.md line that contains the AsyncAPI Git
Workflow Guide reference to use the correct existing path or ensure the files
are relocated to match the new path.
In `@docs/011-styleguide/styling.md`:
- Around line 135-139: The link examples split the URL across two lines in the
markdown snippets for the "[Contribution Guide]" link; fix both instances by
merging the broken URL into a single continuous path (e.g., replace the
multi-line "(../community/ 010-contribution-guidelines)" occurrences used in the
"**✅ Good:** See our [Contribution Guide](...)" and "**❌ Bad:** For more info,
[click here](...)" examples so the target URL is one uninterrupted string inside
the parentheses.
In `@docs/011-styleguide/version-control.md`:
- Around line 98-99: Update the broken Markdown link in the text that currently
points to ../community/010-contribution-guidelines/contribution-flow and is
split across lines: replace it with a single-line link target
../010-contribution-guidelines/contribution-flow so the link Markdown is not
broken (edit the link text "AsyncAPI contribution flow guidelines" to reference
../010-contribution-guidelines/contribution-flow on one line).
| - [ ] Read the list of [technical writer contributor responsibilities](../community/ | ||
| 010-contribution-guidelines/technical-writer-contributor-responsibilities). |
There was a problem hiding this comment.
Fix the multi-line URL syntax.
The link URL is split across two lines, which may not render correctly in all Markdown parsers. Keep the URL on a single line within the parentheses.
📝 Proposed fix
-- [ ] Read the list of [technical writer contributor responsibilities](../community/
-010-contribution-guidelines/technical-writer-contributor-responsibilities).
+- [ ] Read the list of [technical writer contributor responsibilities](../community/010-contribution-guidelines/technical-writer-contributor-responsibilities).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [ ] Read the list of [technical writer contributor responsibilities](../community/ | |
| 010-contribution-guidelines/technical-writer-contributor-responsibilities). | |
| - [ ] Read the list of [technical writer contributor responsibilities](../community/010-contribution-guidelines/technical-writer-contributor-responsibilities). |
🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 15 - 16, The
markdown link for "technical writer contributor responsibilities" is split
across two lines; update the checklist item so the URL inside the parentheses is
on a single line (remove the newline between "../community/" and
"010-contribution-guidelines/technical-writer-contributor-responsibilities")
ensuring the entire URL sits on one line within the parentheses.
| - [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/ | ||
| 010-contribution-guidelines/prerequisite-knowledge). |
There was a problem hiding this comment.
Fix the multi-line URL syntax.
The link URL is split across two lines, which may not render correctly in all Markdown parsers. Keep the URL on a single line within the parentheses.
📝 Proposed fix
-- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
-010-contribution-guidelines/prerequisite-knowledge).
+- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/010-contribution-guidelines/prerequisite-knowledge).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/ | |
| 010-contribution-guidelines/prerequisite-knowledge). | |
| - [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/010-contribution-guidelines/prerequisite-knowledge). |
🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 17 - 18, The
Markdown link for "prerequisite knowledge topics" is broken across two lines;
update the line containing [prerequisite knowledge
topics](../community/010-contribution-guidelines/prerequisite-knowledge) so the
entire URL appears on a single line inside the parentheses (remove the newline
and join the path) to ensure correct rendering.
| - [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../community/ | ||
| 010-contribution-guidelines/git-workflow). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check repository structure and locate the files mentioned
git ls-files | grep -E "(docs-onboarding-checklist|contribution-guidelines)" | head -20Repository: asyncapi/community
Length of output: 1244
🏁 Script executed:
# List the docs directory structure to understand the layout
find docs -type d -name "*onboarding*" -o -name "*contribution*" | head -20Repository: asyncapi/community
Length of output: 168
🏁 Script executed:
# Check if the specific file exists
fd -t f "docs-onboarding-checklist" docs/Repository: asyncapi/community
Length of output: 110
🏁 Script executed:
# Look for git-workflow references
fd -t f "git-workflow" docs/Repository: asyncapi/community
Length of output: 110
🏁 Script executed:
cat -n docs/000-onboarding/docs-onboarding-checklist.md | sed -n '15,30p'Repository: asyncapi/community
Length of output: 1233
Fix the broken and malformed links to contribution guidelines.
The links reference a non-existent ../community/ subdirectory. The correct relative path from docs/000-onboarding/ is ../010-contribution-guidelines/. Additionally, these links are split across multiple lines, which may not render correctly.
Fix all three affected links (lines 15-22):
📝 Proposed fixes
-- [ ] Read the list of [technical writer contributor responsibilities](../community/
-010-contribution-guidelines/technical-writer-contributor-responsibilities).
+- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
-- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
-010-contribution-guidelines/prerequisite-knowledge).
+- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
-- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../community/
-010-contribution-guidelines/git-workflow).
+- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow).🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 21 - 22,
Update the malformed Markdown links that reference a non-existent ../community/
subdirectory: replace occurrences of
"../community/010-contribution-guidelines/git-workflow" with the correct
relative path "../010-contribution-guidelines/git-workflow" and ensure each link
(the three affected links referencing the "AsyncAPI git workflow" /
"contribution guidelines" checklist items) is written on a single line as a
standard Markdown link so it renders correctly.
| For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../community/ | ||
| 010-contribution-guidelines/git-workflow). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify that target files exist at the new community/ paths
echo "Checking if contribution-guidelines files exist in community/ subdirectory..."
# List of target files referenced in the updated links
targets=(
"docs/community/010-contribution-guidelines/git-workflow.md"
"docs/community/010-contribution-guidelines/conventional-commits.md"
"docs/community/010-contribution-guidelines/contribution-flow.md"
"docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md"
"docs/community/010-contribution-guidelines/index.md"
)
echo -e "\n=== Checking new community/ paths ==="
for target in "${targets[@]}"; do
if [ -f "$target" ]; then
echo "✓ EXISTS: $target"
else
echo "✗ MISSING: $target"
fi
done
echo -e "\n=== Checking old non-community/ paths ==="
# Also check if files exist at the OLD paths (without community/)
old_targets=(
"docs/010-contribution-guidelines/git-workflow.md"
"docs/010-contribution-guidelines/conventional-commits.md"
"docs/010-contribution-guidelines/contribution-flow.md"
"docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md"
)
for target in "${old_targets[@]}"; do
if [ -f "$target" ]; then
echo "✓ EXISTS: $target"
else
echo "✗ MISSING: $target"
fi
done
echo -e "\n=== Actual directory structure ==="
# Show actual directory structure to confirm where files are located
echo "Contents of docs/:"
fd -t d -d 1 . docs/ 2>/dev/null || find docs/ -mindepth 1 -maxdepth 1 -type d
echo -e "\nContents of docs/010-contribution-guidelines/:"
fd -t f . docs/010-contribution-guidelines/ 2>/dev/null | head -10 || find docs/010-contribution-guidelines/ -type f 2>/dev/null | head -10
if [ -d "docs/community" ]; then
echo -e "\nContents of docs/community/:"
fd -t d -d 2 . docs/community/ 2>/dev/null || find docs/community/ -mindepth 1 -maxdepth 2 -type d 2>/dev/null
fiRepository: asyncapi/community
Length of output: 1824
Links to contribution-guidelines files will be broken.
The verification confirms that all target files referenced in the updated links do NOT exist at the new docs/community/010-contribution-guidelines/ paths. The files remain at their original locations: docs/010-contribution-guidelines/. No docs/community/ subdirectory exists in the repository.
Adding the community/ segment to these paths will create broken links (404s). Either revert the path changes to remove the community/ prefix, or move the contribution-guidelines files to the docs/community/010-contribution-guidelines/ directory structure.
🤖 Prompt for AI Agents
In `@docs/000-onboarding/maintainer-guide.md` around lines 49 - 50, The link in
maintainer-guide.md was changed to include a non-existent community/ segment
("../community/010-contribution-guidelines/git-workflow") which causes a broken
link; revert the link target to the existing path
("../010-contribution-guidelines/git-workflow") or move the
contribution-guidelines files into docs/community/010-contribution-guidelines
and update all references accordingly so that references like
"../community/010-contribution-guidelines/git-workflow" point to an actual file;
update the link in the maintainer-guide.md line that contains the AsyncAPI Git
Workflow Guide reference to use the correct existing path or ensure the files
are relocated to match the new path.
| - **✅ Good:** See our [Contribution Guide](../community/ | ||
| 010-contribution-guidelines) for more. | ||
|
|
||
| - **❌ Bad:** For more info, [click here](../010-contribution-guidelines). | ||
| - **❌ Bad:** For more info, [click here](../community/ | ||
| 010-contribution-guidelines). |
There was a problem hiding this comment.
Fix the multi-line URL syntax in link examples.
These are example snippets demonstrating proper link formatting, but the URLs are split across multiple lines, which is non-standard Markdown syntax. The examples should demonstrate correct single-line URL formatting.
📝 Proposed fix for both examples
-- **✅ Good:** See our [Contribution Guide](../community/
-010-contribution-guidelines) for more.
+- **✅ Good:** See our [Contribution Guide](../community/010-contribution-guidelines) for more.
-- **❌ Bad:** For more info, [click here](../community/
-010-contribution-guidelines).
+- **❌ Bad:** For more info, [click here](../community/010-contribution-guidelines).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **✅ Good:** See our [Contribution Guide](../community/ | |
| 010-contribution-guidelines) for more. | |
| - **❌ Bad:** For more info, [click here](../010-contribution-guidelines). | |
| - **❌ Bad:** For more info, [click here](../community/ | |
| 010-contribution-guidelines). | |
| - **✅ Good:** See our [Contribution Guide](../community/010-contribution-guidelines) for more. | |
| - **❌ Bad:** For more info, [click here](../community/010-contribution-guidelines). |
🤖 Prompt for AI Agents
In `@docs/011-styleguide/styling.md` around lines 135 - 139, The link examples
split the URL across two lines in the markdown snippets for the "[Contribution
Guide]" link; fix both instances by merging the broken URL into a single
continuous path (e.g., replace the multi-line "(../community/
010-contribution-guidelines)" occurrences used in the "**✅ Good:** See our
[Contribution Guide](...)" and "**❌ Bad:** For more info, [click here](...)"
examples so the target URL is one uninterrupted string inside the parentheses.
| Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/ | ||
| 010-contribution-guidelines/contribution-flow). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Find the actual location of contribution-flow.md
echo "=== Searching for contribution-flow.md ==="
fd -t f "contribution-flow.md"
# Check the docs directory structure
echo -e "\n=== Docs directory structure ==="
find docs -type d -name "*contribution*" -o -name "*onboarding*" | head -20
# Verify the file under review exists
echo -e "\n=== Checking the file under review ==="
if [ -f "docs/011-styleguide/version-control.md" ]; then
echo "File exists at docs/011-styleguide/version-control.md"
# Show lines 98-99 with context
echo -e "\n=== Lines 95-102 from version-control.md ==="
sed -n '95,102p' docs/011-styleguide/version-control.md
else
echo "File not found at expected path"
fiRepository: asyncapi/community
Length of output: 737
Fix the broken link path and remove the multi-line syntax.
The link target ../community/010-contribution-guidelines/contribution-flow is incorrect—there is no community subdirectory in the docs folder. The correct path is ../010-contribution-guidelines/contribution-flow. Additionally, the URL is split across two lines, breaking Markdown link syntax.
Proposed fix
-Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/
-010-contribution-guidelines/contribution-flow).
+Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/ | |
| 010-contribution-guidelines/contribution-flow). | |
| Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow). |
🤖 Prompt for AI Agents
In `@docs/011-styleguide/version-control.md` around lines 98 - 99, Update the
broken Markdown link in the text that currently points to
../community/010-contribution-guidelines/contribution-flow and is split across
lines: replace it with a single-line link target
../010-contribution-guidelines/contribution-flow so the link Markdown is not
broken (edit the link text "AsyncAPI contribution flow guidelines" to reference
../010-contribution-guidelines/contribution-flow on one line).
|
🚀 Docs preview deployed |
2 participants
Description
Fixes broken links in the Community Onboarding documentation that were pointing to incorrect paths.
Several references to
010-contribution-guidelineswere missing thecommunity/segment, which caused 404 errors on the published site.Changes
community/where required.Type of change
Documentation fix (broken links)
Checklist
Summary by CodeRabbit