Skip to content

Fix prototype-api docs path issues after structure update#11391

Closed
PabasaraIlankoon wants to merge 5 commits into
wso2:masterfrom
PabasaraIlankoon:master
Closed

Fix prototype-api docs path issues after structure update#11391
PabasaraIlankoon wants to merge 5 commits into
wso2:masterfrom
PabasaraIlankoon:master

Conversation

@PabasaraIlankoon
Copy link
Copy Markdown

@PabasaraIlankoon PabasaraIlankoon commented May 20, 2026

Purpose

Fixed broken relative image paths in prototype API documentation that were causing MkDocs build warnings.

Goals

Correct the relative paths for images in backend-url-prototype-api.md and create-mocked-js-api.md so images display correctly.

Approach

Changed incorrect relative paths from ../../../../assets to ../../../assets as suggested by mkdocs build warnings.

User stories

N/A

Release note

N/A

Documentation

N/A - This PR is a documentation fix itself.

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

  • Unit tests

    N/A - Documentation fix only, no code changes.

Security checks

  • Followed secure coding standards: N/A (documentation only)
  • Ran FindSecurityBugs plugin: N/A (documentation only)
  • Confirmed no keys/passwords/secrets committed: yes

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

Windows 11, Python 3.12, MkDocs 1.5.3

Learning

Identified broken image paths from mkdocs build warnings and corrected the relative path depth.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This 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)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed Pull request description follows the required template structure with all key sections completed appropriately for a documentation fix.
Title check ✅ Passed The title accurately describes the primary change: fixing relative path issues in documentation files across multiple prototype-API and related docs after a structure update.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between fefbd7c and bba2d8c.

📒 Files selected for processing (2)
  • en/docs/administer/advanced-configurations.md
  • en/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>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

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.

Suggested change
<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.

@PabasaraIlankoon PabasaraIlankoon changed the title Fix broken image paths in prototype-api docs Fix prototype-api docs path issues after structure update May 20, 2026
@PabasaraIlankoon PabasaraIlankoon closed this by deleting the head repository May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants