fix(docs): correct broken' AsyncAPI' reference link#1889
fix(docs): correct broken' AsyncAPI' reference link#1889SHUBHANSHU602 wants to merge 1 commit intoasyncapi:masterfrom
Conversation
SHUBHANSHU602
requested review from
Florence-Njeri,
asyncapi-bot-eve and
derberg
as code owners
|
What reviewer looks at during PR reviewThe following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.
|
📝 WalkthroughWalkthroughUpdated an internal documentation link in the model generation guide, changing an AsyncAPI reference from a relative path to point to an internal AsyncAPI document path within the generator application structure. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@apps/generator/docs/model-generation.md`:
- Line 8: Summary: The internal documentation link target exposes repo structure
and should use the site's routing pattern; replace the current
"/generator/apps/generator/docs/asyncapi-document" link target. Locate the
Markdown line containing the link text "[AsyncAPI]" and change its target to the
relative doc route "(asyncapi-document)" (or "(generator/asyncapi-document)" if
you prefer the index-style pattern) so the link matches other docs like
versioning.md/template.md; ensure only the URL portion inside the parentheses is
changed and the visible link text "[AsyncAPI]" remains unchanged.
| This guide will walk you through the process of enabling models/types generation in a template by using [Modelina](https://www.asyncapi.com/tools/modelina). | ||
|
|
||
| Modelina is an AsyncAPI library designed for generating data models using inputs such as [AsyncAPI](generator/asyncapi-document), OpenAPI, or JSON schema inputs. Its functionality revolves around creating data models from the provided AsyncAPI document and the model template, which defines message payloads. It is better to use Modelina in your template to handle model generation rather than providing custom templates. | ||
| Modelina is an AsyncAPI library designed for generating data models using inputs such as [AsyncAPI](/generator/apps/generator/docs/asyncapi-document), OpenAPI, or JSON schema inputs. Its functionality revolves around creating data models from the provided AsyncAPI document and the model template, which defines message payloads. It is better to use Modelina in your template to handle model generation rather than providing custom templates. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Find files related to asyncapi-document
fd -H "asyncapi-document" apps/generator/docs/ 2>/dev/null || echo "No exact match found"
# List the docs structure to understand organization
find apps/generator/docs -type f -name "*.md" | head -20
# Check if the file exists with common extensions
ls -la apps/generator/docs/ 2>/dev/null | grep -i asyncapi || echo "No asyncapi files in directory listing"Repository: asyncapi/generator
Length of output: 924
🏁 Script executed:
#!/bin/bash
# Check front-matter of asyncapi-document.md
head -20 apps/generator/docs/asyncapi-document.md
# Check the model-generation.md file to see the exact link format
cat -n apps/generator/docs/model-generation.md | head -15
# Look for docs site configuration
fd -H "docusaurus|sidebars|mkdocs|nextra|config" . 2>/dev/null | grep -E "(config|docusaurus|sidebars)" | head -10
# Check root level config files
ls -la | grep -E "(\.config|package\.json|docusaurus|mkdocs|sidebars)"Repository: asyncapi/generator
Length of output: 3348
🏁 Script executed:
#!/bin/bash
# Check for website configuration
fd -H "website|site" . --type d | head -10
# Check other markdown files to see how internal links are formatted
rg -n '\[.*\]\(/' apps/generator/docs/ | head -20
# Look for docusaurus or other docs config in website dir
fd -H "config|docusaurus" website 2>/dev/null | head -10
# Check the main package.json for docs-related scripts
cat package.json | grep -A5 -B5 "doc\|site"Repository: asyncapi/generator
Length of output: 2237
🏁 Script executed:
#!/bin/bash
# Search for all internal links in docs to understand the pattern
rg -n '\]\(/docs/tools/generator' apps/generator/docs/
# Search for any references to asyncapi-document
rg -n 'asyncapi-document' apps/generator/docs/
# Check if there's any route mapping or docs config
find . -name "*route*" -o -name "*config*" -o -name "*docusaurus*" | grep -E "(website|docs|config)" | head -15Repository: asyncapi/generator
Length of output: 5308
Correct the internal documentation link path.
The link on line 8 uses /generator/apps/generator/docs/asyncapi-document, which exposes internal filesystem structure and doesn't match the documentation site's routing pattern.
Based on other links in the docs, this should be either:
(asyncapi-document)for a relative link (consistent withversioning.md,template.md,template-context.md)(generator/asyncapi-document)for consistency with the pattern used inindex.md
Update the link accordingly.
🤖 Prompt for AI Agents
In `@apps/generator/docs/model-generation.md` at line 8, Summary: The internal
documentation link target exposes repo structure and should use the site's
routing pattern; replace the current
"/generator/apps/generator/docs/asyncapi-document" link target. Locate the
Markdown line containing the link text "[AsyncAPI]" and change its target to the
relative doc route "(asyncapi-document)" (or "(generator/asyncapi-document)" if
you prefer the index-style pattern) so the link matches other docs like
versioning.md/template.md; ensure only the URL portion inside the parentheses is
changed and the visible link text "[AsyncAPI]" remains unchanged.
|
hey @coderabbitai can you please see the repo ,which are the deprecated dependencies ,which should be removed |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain
🏁 Script executed: Length of output: 897 🏁 Script executed: Length of output: 360 🏁 Script executed: Length of output: 1093 🏁 Script executed: Length of output: 9130 🏁 Script executed: Length of output: 198 🏁 Script executed: Length of output: 389
🚨 Officially Deprecated Packages1.
|
2 participants
What this PR does
Fixes a broken "AsyncAPI" documentation link that currently points to a non-existent path.
Root cause
The link was resolving to:
generator/asyncapi-documentwhich results in a 404 due to duplicated path segments.
Solution
Updated the link to the correct one:
/generator/apps/generator/docs/asyncapi-documentRelated issue #1836
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.