Fix image loading issue in MTLS doc#117
Conversation
WalkthroughAdded several new documentation pages for GraphQL workflows and AWS gateway federation, updated navigation (en/mkdocs.yml), moved an import-from-GitHub doc into an http subfolder, and corrected/standardized relative image asset paths and a few minor text tweaks across affected docs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md(4 hunks)
🔇 Additional comments (1)
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md (1)
49-49: Inline style attributes are consistently applied with appropriate widths.All image embeds now include explicit width constraints using valid Kramdown syntax
{: style="width:XXXpx"}. The width distribution is sensible: 300px for dialog/compact UI elements (lines 49, 77) and 500px for larger detailed views (lines 55, 59, 83, 87, 100). This ensures predictable rendering across different screen sizes.Also applies to: 55-55, 59-59, 77-77, 83-83, 87-87, 100-100
| {: style="width:500px"} | ||
|
|
||
| This opens the certificate for you to view and download. | ||
| This opens the certificate for you to view and download. |
There was a problem hiding this comment.
🧩 Analysis chain
Minor text formatting anomaly.
Line 85 contains "the certificate" with an extra space. Confirm whether this is intentional or an unintended artifact from the editing process.
🏁 Script executed:
#!/bin/bash
# Description: Check for double spaces and other formatting anomalies in the updated file.
# Search for double spaces in the file
grep -n " " "en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md" | head -10Length of output: 1332
I need to verify the exact content at line 85 to confirm the double space issue.
---
🏁 Script executed:
```shell
#!/bin/bash
# Display line 85 specifically
sed -n '85p' "en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md"
Length of output: 64
Fix double space in line 85.
Line 85 contains "the certificate" with an extra space. Update to "the certificate".
🤖 Prompt for AI Agents
In
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md
around line 85, there is a double space in the phrase "the certificate"; edit
that line to remove the extra space so it reads "the certificate" (i.e., replace
the two spaces with a single space).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@en/docs/federation/api-discovery-aws.md`:
- Around line 58-64: The numbered list in the "Discover APIs" section has
duplicate step numbers: change the second "3. Select the external gateway(s)..."
to "4." and increment all following steps (previous 5→6, 6→7, 7→8) so the
sequence after "Click on **Discover APIs**" reads correctly; update the lines
containing the texts "Click on **Discover APIs**", "Select the external
gateway(s) from which you want to discover APIs and proceed with discovery.",
and "Click **Discover APIs from Gateways**." accordingly to maintain a
consecutive numbering sequence.
🧹 Nitpick comments (5)
en/docs/federation/api-discovery-aws.md (1)
42-44: Minor formatting inconsistencies.
- Line 42: Extra space before the colon in "Access Key :" — should be "Access Key:"
- Line 44: Missing period after "Click Save" for consistency with other steps
📝 Proposed fix
- - **Access Key :** The Access Key from Step 1 + - **Access Key:** The Access Key from Step 1 - **Secret Key:** The Secret Key from Step 1 -4. Click **Save** +4. Click **Save**.en/docs/test-api-proxy/graphql-console.md (1)
15-16: Improve button reference clarity."Click The Play Button" is awkward phrasing. Consider rephrasing to be more consistent with typical UI documentation style.
📝 Proposed fix
-6. Click **The Play Button**. The response from the GraphQL API proxy will be displayed under the **Response** section. +6. Click the **Play** button (▶). The response from the GraphQL API proxy will be displayed in the **Response** section.en/docs/create-api-proxy/my-apis/graphql/start-with-endpoint.md (3)
22-22: Format UI element consistently.The "+ Create" text should be formatted as a UI element for consistency with other documentation.
📝 Proposed fix
-2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step. +2. If you already have one or more components in your project, click **+ Create**. Otherwise, proceed to the next step.
43-43: Use consistent navigation notation.The arrow notation "Test --> Console" differs from the standard navigation style used elsewhere in the documentation (e.g., "Test in the left navigation menu, then select Console").
📝 Proposed fix
-1. Navigate to the **Test --> Console** page of the API Proxy. +1. In the left navigation menu, click **Test**, then select **Console**.
46-46: Inconsistent capitalization in heading.The heading uses both "API Proxy" and "API proxy" inconsistently.
📝 Proposed fix
-## Promote the API Proxy to Production and Publish the API proxy +## Promote the API Proxy to Production and Publish the API Proxy
| 3. Click on **Discover APIs**. | ||
|
|
||
| { width="1000" } | ||
|
|
||
| 3. Select the external gateway(s) from which you want to discover APIs and proceed with discovery. | ||
|
|
||
| 4. Click **Discover APIs from Gateways**. |
There was a problem hiding this comment.
Fix duplicate step numbering.
There are two steps numbered "3" in this section. Line 58 starts "3. Click on Discover APIs" and line 62 starts "3. Select the external gateway(s)...". The second should be step 4.
📝 Proposed fix
3. Click on **Discover APIs**.
{ width="1000" }
-3. Select the external gateway(s) from which you want to discover APIs and proceed with discovery.
+4. Select the external gateway(s) from which you want to discover APIs and proceed with discovery.
-4. Click **Discover APIs from Gateways**.
+5. Click **Discover APIs from Gateways**.Also update subsequent step numbers (5→6, 6→7, 7→8).
📝 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.
| 3. Click on **Discover APIs**. | |
| { width="1000" } | |
| 3. Select the external gateway(s) from which you want to discover APIs and proceed with discovery. | |
| 4. Click **Discover APIs from Gateways**. | |
| 3. Click on **Discover APIs**. | |
| { width="1000" } | |
| 4. Select the external gateway(s) from which you want to discover APIs and proceed with discovery. | |
| 5. Click **Discover APIs from Gateways**. |
🧰 Tools
🪛 LanguageTool
[style] ~62-~62: Consider using an alternative to strengthen your wording.
Context: ... the external gateway(s) from which you want to discover APIs and proceed with disco...
(WANT_KEEN)
🤖 Prompt for AI Agents
In `@en/docs/federation/api-discovery-aws.md` around lines 58 - 64, The numbered
list in the "Discover APIs" section has duplicate step numbers: change the
second "3. Select the external gateway(s)..." to "4." and increment all
following steps (previous 5→6, 6→7, 7→8) so the sequence after "Click on
**Discover APIs**" reads correctly; update the lines containing the texts "Click
on **Discover APIs**", "Select the external gateway(s) from which you want to
discover APIs and proceed with discovery.", and "Click **Discover APIs from
Gateways**." accordingly to maintain a consecutive numbering sequence.
|
Opened a new PR due to conflicts: #125 |
6 participants
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.