-
-
Notifications
You must be signed in to change notification settings - Fork 177
docs: fix broken link to contribution guidelines in onboarding docs #2291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,11 +12,14 @@ Complete in order the following onboarding tasks: | |||||||
| - [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette). | ||||||||
| - [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite). | ||||||||
| - [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events). | ||||||||
| - [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities). | ||||||||
| - [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge). | ||||||||
| - [ ] Read the list of [technical writer contributor responsibilities](../community/ | ||||||||
| 010-contribution-guidelines/technical-writer-contributor-responsibilities). | ||||||||
| - [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/ | ||||||||
| 010-contribution-guidelines/prerequisite-knowledge). | ||||||||
|
Comment on lines
+17
to
+18
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Suggested change
🤖 Prompt for AI Agents |
||||||||
| - [ ] Familiarize yourself with the [AsyncAPI Style Guide](../011-styleguide). | ||||||||
| - [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.) | ||||||||
| - [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow). | ||||||||
| - [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../community/ | ||||||||
| 010-contribution-guidelines/git-workflow). | ||||||||
|
Comment on lines
+21
to
+22
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 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 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 |
||||||||
| - [ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs. | ||||||||
| - [ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite). | ||||||||
| - [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers. | ||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,7 +46,8 @@ Before you can become a **maintainer**, you need to start as a **contributor**. | |
|
|
||
| ### 2. Open a PR | ||
|
|
||
| For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../010-contribution-guidelines/git-workflow). | ||
| 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). | ||
|
Comment on lines
+49
to
+50
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 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 Adding the 🤖 Prompt for AI Agents |
||
|
|
||
| - **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -132,9 +132,11 @@ Use asterisks for italics (`*italic*`) and bold (`**bold**`). You can also use u | |||||||||||||||||||
| ### Links | ||||||||||||||||||||
| Use square brackets to describe links and a parenthesis to insert the actual links. Always use descriptive link text. Avoid phrases like "click here." | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **✅ Good:** See our [Contribution Guide](../010-contribution-guidelines) for more. | ||||||||||||||||||||
| - **✅ 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). | ||||||||||||||||||||
|
Comment on lines
+135
to
+139
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Code Blocks | ||||||||||||||||||||
| Use backticks for inline code (`const foo = 'bar';`). For code blocks, use triple backticks and specify the language for syntax highlighting. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -95,4 +95,5 @@ When contributing to documentation, keep the following in mind: | |||||||
|
|
||||||||
| ### Need Help? | ||||||||
|
|
||||||||
| Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow). | ||||||||
| Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/ | ||||||||
| 010-contribution-guidelines/contribution-flow). | ||||||||
|
Comment on lines
+98
to
+99
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 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 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
Suggested change
🤖 Prompt for AI Agents |
||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
📝 Committable suggestion
🤖 Prompt for AI Agents