docs: short URLs guide for website #2129
Conversation
vishvamsinh28
requested review from
asyncapi-bot-eve,
bandantonio,
derberg and
thulieblack
as code owners
WalkthroughAdds a new documentation guide at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/040-guides/create-short-urls.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/040-guides/create-short-urls.md
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
32-32: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
43-43: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
62-62: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: preview
🔇 Additional comments (4)
docs/040-guides/create-short-urls.md (4)
1-5: Frontmatter looks good.Clear title, helpful description, and reasonable weight for documentation hierarchy.
7-11: Introduction is clear and well-motivated.Good use of concrete examples and explanation of benefits. The note about the existing file is helpful context.
84-86: Closing is effective and encouraging.Good conclusion that reinforces the value of the guide for the community.
1-86: Overall: Documentation is comprehensive and well-organized.The guide clearly explains the purpose, mechanics, and workflow for managing short URLs. The step-by-step instructions are actionable, and the examples are practical. Once the four fenced code block language specifications are added (MD040 fixes), this guide will be ready for publication.
|
🚀 Docs preview deployed |
|
🚀 Docs preview deployed |
vishvamsinh28
changed the title
|
it would look more clean without /s/ path wdyt ? |
|
but it cannot as it will conflict with other paths that actually point to real content, like
|
|
makes sense, lets go with /s for short URLs. i’ll update the doc |
|
@derberg updated the doc |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/040-guides/create-short-urls.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: preview
🔇 Additional comments (2)
docs/040-guides/create-short-urls.md (2)
50-83: Workflow steps are well-structured and actionable.The step-by-step guide is clear, comprehensive, and includes good practices like using Deploy Preview for validation and documenting context in the PR. The example in Step 2 correctly follows the
/s/prefix requirement.
1-87: Overall documentation is clear, well-structured, and complete.Once the examples inconsistency (lines 44–48) is corrected, this guide will be excellent. The document effectively covers purpose, constraints, technical details, syntax, status codes, and a practical workflow. The markdown structure follows best practices with proper language identifiers on code blocks. Well done balancing technical accuracy with accessibility for community members.
|
🚀 Docs preview deployed |
|
🚀 Docs preview deployed |
|
/bounty |
|
🚀 Docs preview deployed |
|
@sambhavgupta0705 PTAL |
|
🚀 Docs preview deployed |
|
🚀 Docs preview deployed |
|
🚀 Docs preview deployed |
|
🚀 Docs preview deployed |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/040-guides/create-short-urls.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-04-29T11:49:47.903Z
Learnt from: thulieblack
Repo: asyncapi/community PR: 1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
Applied to files:
docs/040-guides/create-short-urls.md
🪛 markdownlint-cli2 (0.18.1)
docs/040-guides/create-short-urls.md
36-36: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: preview
🔇 Additional comments (1)
docs/040-guides/create-short-urls.md (1)
1-67: Documentation is clear and well-structured.The guide effectively communicates how to create short URLs with proper
/s/prefix requirements, clear syntax rules, and practical step-by-step instructions. Code examples now correctly demonstrate the/s/prefix standard. All code blocks have appropriate language identifiers, and previous review feedback has been well-integrated.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/040-guides/create-short-urls.md (1)
59-59: Minor punctuation clarification needed.Line 59 needs a comma or restructuring for clarity: "Deploy Preview will be generated for the PR use it to validate your redirect." Consider: "Deploy Preview will be generated for the PR; use it to validate your redirect." or "A Deploy Preview will be generated for the PR—use it to validate your redirect."
- 4. Deploy Preview will be generated for the PR use it to validate your redirect. + 4. A Deploy Preview will be generated for the PR—use it to validate your redirect.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/040-guides/create-short-urls.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-04-29T11:49:47.903Z
Learnt from: thulieblack
Repo: asyncapi/community PR: 1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
Applied to files:
docs/040-guides/create-short-urls.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: preview
🔇 Additional comments (1)
docs/040-guides/create-short-urls.md (1)
1-67: Documentation is well-structured and complete.This guide effectively explains how to create short URLs for the AsyncAPI website. The file location is correct, the syntax is clearly presented with proper examples using the
/s/prefix, and the step-by-step instructions are actionable. The mention of deploy preview validation is a practical QA step. All code blocks have proper language identifiers per markdown best practices.
|
@bandantonio could you please review it once again ? |
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
can you as part of your work also add the short link that will replace https://bit.ly/asyncapi that is currently used in website? and also update revelant places in website?
asyncapi.com/s/asyncapiv2
also better example here than studio really
|
sure, will update it tomorrow 👍 |
|
@derberg replaced all bitly occurences |
7 participants
Added a new guide for creating and using short URLs on the website, including best practices, syntax, step-by-step instructions, and examples.
asyncapi/website#3005
cc @aeworxet
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.