Skip to content

Fix broken image links in generate-api-key.md by using base_path#11559

Open
Ravinx001 wants to merge 1 commit into
wso2:masterfrom
Ravinx001:fix-issue-11557
Open

Fix broken image links in generate-api-key.md by using base_path#11559
Ravinx001 wants to merge 1 commit into
wso2:masterfrom
Ravinx001:fix-issue-11557

Conversation

@Ravinx001

Copy link
Copy Markdown

Purpose

Resolves #11557

Goals

Fix broken image links in the API keys documentation which previously used hardcoded relative paths that broke when the snippet was included in other pages.

Approach

Replaced the hardcoded relative directory paths (../../../../assets) with the dynamic {{base_path}}/assets macro inside en/docs/includes/design/generate-api-key.md.

User stories

N/A

Release note

Fixed broken image links in the API keys documentation.

Documentation

This PR is a documentation fix.

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

  • Unit tests

    N/A

  • Integration tests

    N/A

Security checks

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

Tested locally using mkdocs serve.

Learning

N/A

Signed-off-by: Ravindu Amarasekara <rav.business.lak@gmail.com>
@CLAassistant

CLAassistant commented Jul 7, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 49491bc0-5025-496b-b884-220a2c8850bf

📥 Commits

Reviewing files that changed from the base of the PR and between 74c9cda and d311419.

📒 Files selected for processing (1)
  • en/docs/includes/design/generate-api-key.md

📝 Walkthrough

Updated the Generate API Key documentation to use {{base_path}}/assets for embedded screenshots instead of hardcoded relative paths. This fixes broken images when the include is rendered from other documentation pages, including the API keys guide and the subscription-based API key flow. The change is documentation-only and was locally verified with mkdocs serve.

Walkthrough

This change updates the "Generate API Key" documentation page by replacing hardcoded relative screenshot paths with {{base_path}}-templated image URLs. Affected sections include the left-menu navigation and API key generation step, the generated API key response screenshot, and the subscription-enabled association workflow, which now includes additional screenshots for both the direct association path and the alternative association via the subscribed application's "API Keys" page.

Related Issues: #11557

Suggested Labels: documentation

Suggested Reviewers: None specified

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: fixing broken image links in generate-api-key.md via base_path.
Description check ✅ Passed The description follows the template and includes the required sections with clear purpose, approach, testing, and release note details.
Linked Issues check ✅ Passed The change addresses issue #11557 by replacing broken relative image paths with {{base_path}} links in the documented API keys snippet.
Out of Scope Changes check ✅ Passed The PR stays within scope and only updates the documentation image paths related to the reported issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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.

@chamilaadhi

chamilaadhi commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

@Ravinx001 Can you send the same pr to https://github.com/wso2/docs-apim/tree/4.7.0 branch as well please

@Ravinx001

Copy link
Copy Markdown
Author

@chamilaadhi

It's Done.

Here is the new PR - #11565

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.

Image links are broken in the API keys doc

3 participants