Fix: Update hardcoded Mocky URL to placeholder#11495
Conversation
Replaced the static, hardcoded Mocky endpoint with a descriptive placeholder in the Quick Start Guide to improve clarity for users.
📝 WalkthroughWalkthroughThis change updates the API Manager quick start guide to improve usability by replacing a hard-coded Mocky endpoint URL with a template placeholder. Line 121 of 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/get-started/api-manager-quick-start-guide.md`:
- Line 121: Escape the angle brackets around the placeholder inside the code
element so it renders literally; replace the current snippet
<code>https://run.mocky.io/v3/<YOUR_GENERATED_MOCKY_ID></code> with the
placeholder using HTML escapes for the brackets (e.g.
<YOUR_GENERATED_MOCKY_ID>) so the renderer does not treat it as an HTML
tag.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d43c4a3c-0138-4db1-bb9d-0d9e7e0e31f5
📒 Files selected for processing (1)
en/docs/get-started/api-manager-quick-start-guide.md
Replaced the static, hardcoded Mocky endpoint with a descriptive placeholder in the Quick Start Guide to improve clarity for users.
Purpose
The Quick Start Guide currently provides a hardcoded, static Mocky URL. If a user utilizes the hardcoded link, it removes the purpose of the step where they generate their own mock service.
Goals
Replace the static endpoint with a clear, descriptive placeholder (<YOUR_GENERATED_MOCKY_ID>) so users know to use their own unique generated resource.
Approach
Updated en/docs/get-started/api-manager-quick-start-guide.md to use the placeholder format inside the REST API configuration table.
Learning
Learned the end-to-end open-source contribution workflow, including forking repositories, utilizing the GitHub web-based editor and submitting pull requests. Gained experience in navigating and auditing documentation to resolve configuration discrepancies.