Fix prototype-api docs path issues after structure update#11391
Fix prototype-api docs path issues after structure update#11391PabasaraIlankoon wants to merge 5 commits into
Conversation
|
|
📝 WalkthroughWalkthroughThis PR fixes embedded screenshot links and minor markdown/formatting in four docs files: deploy-revision.md (adjusted image paths and note/image alignment), invoke-prerelease-api.md (updated prototype publish screenshot links and Step 5 formatting), advanced-configurations.md (replaced templated image URL with a domain-based URL), and ai-backend-security.md (switched an HTML anchor to Markdown and tightened note punctuation/capitalization). No functional code changes. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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: 2
🤖 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/administer/advanced-configurations.md`:
- Line 16: The image tag in en/docs/administer/advanced-configurations.md (<img
src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/>)
is missing an alt attribute; add a concise alt text such as alt="Advanced
configurations save dialog screenshot" to the <img> element so the anchor's
image has accessible descriptive text.
- Line 16: Replace the placeholder/malformed image URL in the anchor and img tag
(the href and src in the existing <a> and <img> elements referencing
advanced-config-save.png) with the resolvable docs path using the same pattern
used elsewhere in this file: use
{{base_path}}/assets/img/administer/advanced-config-save.png for both href and
src so the screenshot renders correctly.
🪄 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: e66ce9ea-58a9-44aa-9d69-b46dd54ce82a
📒 Files selected for processing (2)
en/docs/administer/advanced-configurations.mden/docs/ai-gateway/ai-backend-security.md
✅ Files skipped from review due to trivial changes (1)
- en/docs/ai-gateway/ai-backend-security.md
| 1. Change the relevant configuration accordingly and click **Save**. | ||
|
|
||
| <a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png"/></a> | ||
| <a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a> |
There was a problem hiding this comment.
Add alt text for the image.
Line 16 image markup is missing an alt attribute. Please add concise alt text for accessibility.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 16-16: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for 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.
In `@en/docs/administer/advanced-configurations.md` at line 16, The image tag in
en/docs/administer/advanced-configurations.md (<img
src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/>)
is missing an alt attribute; add a concise alt text such as alt="Advanced
configurations save dialog screenshot" to the <img> element so the anchor's
image has accessible descriptive text.
Fix the image URL to a resolvable docs path.
Line 16 uses a placeholder host and a malformed path (.../learn/.../assets/...), so this screenshot link will not render correctly in published docs. Use the same path pattern already used in this file (for example, {{base_path}}/assets/img/administer/advanced-config-save.png) for both href and src.
Proposed fix
- <a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a>
+ <a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png" alt="Advanced configuration save action"/></a>📝 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.
| <a href="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"><img src="https://<your-docs-domain>/assets/img/learn/.../assets/img/administer/advanced-config-save.png"/></a> | |
| <a href="{{base_path}}/assets/img/administer/advanced-config-save.png"><img src="{{base_path}}/assets/img/administer/advanced-config-save.png" alt="Advanced configuration save action"/></a> |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 16-16: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for 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.
In `@en/docs/administer/advanced-configurations.md` at line 16, Replace the
placeholder/malformed image URL in the anchor and img tag (the href and src in
the existing <a> and <img> elements referencing advanced-config-save.png) with
the resolvable docs path using the same pattern used elsewhere in this file: use
{{base_path}}/assets/img/administer/advanced-config-save.png for both href and
src so the screenshot renders correctly.
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning