Apply sentence-case fixes to headings #1892
Conversation
Updated multiple documentation headings to follow sentence-style capitalization according to the Microsoft Writing Style Guide. This includes adjusting capitalization, fixing improper casing, and ensuring consistency across the docs.
Sachindu-Nethmin
requested review from
GDLMadushanka,
SanojPunchihewa,
anupama-pathirage,
arunans23,
chanikag and
rosensilva
as code owners
WalkthroughThis PR updates documentation heading capitalization across 35+ files, converting title case to sentence case (e.g., "What's Next?" → "What's next?"). Additionally, a few files include minor content expansions with new examples, navigation links, and explanatory sections for features and workflows. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~20 minutes
Areas requiring attention:
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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 |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (10)
en/docs/develop/advanced-development/changing-the-endpoint-of-deployed-service.md (1)
125-134: Add an info string to the fenced XML block (and align formatting with the QA example). The Dev section’s code fence is currently untyped (Line 127), while the QA section uses```xml(Line 151), so this may render with inconsistent highlighting/formatting.-``` +```xml <body> - <p:echoInt xmlns:p="http://echo.services.core.carbon.wso2.org"> - <!--0 to 1 occurrence--> - <in>50</in> - </p:echoInt> + <p:echoInt xmlns:p="http://echo.services.core.carbon.wso2.org"> + <!--0 to 1 occurrence--> + <in>50</in> + </p:echoInt> </body>-->
en/docs/mi-analytics/mi-elk-dashboards.md (1)
128-173: Fix invalid JSON syntax in the payload example.The JSON payload example on lines 148–170 contains trailing commas that make it invalid JSON:
- Line 164: trailing comma after
"api": "userRegistrationAPI",- Line 166: trailing comma after
"faultResponse": false,These commas will cause JSON parsing to fail, which could mislead users attempting to use this as a reference implementation. The explanatory content and example API XML are clear and educational; the JSON just needs correcting.
Apply this diff to remove the trailing commas:
"subRequestPath": "/signup", "api": "userRegistrationAPI" }, - "faultResponse": false, + "faultResponse": false },en/docs/learn/examples/protocol-switching/switching-from-ftp-listener-to-mail-sender.md (1)
55-56: Fix spelling error: "deatails" → "details".Lines 55 and 56 contain a typo that should be corrected.
- 4. Create the [endpoint]({{base_path}}/develop/creating-artifacts/creating-endpoints/) with the given deatails for SimpleStockQuoteService Endpoint. - 5. Create the [endpoint]({{base_path}}/develop/creating-artifacts/creating-endpoints/) with the given deatails for Mail Endpoint. + 4. Create the [endpoint]({{base_path}}/develop/creating-artifacts/creating-endpoints/) with the given details for SimpleStockQuoteService Endpoint. + 5. Create the [endpoint]({{base_path}}/develop/creating-artifacts/creating-endpoints/) with the given details for Mail Endpoint.en/docs/develop/customizations/ballerina-module/overview.md (1)
49-49: Inconsistent heading capitalization: Line 49 should align with sentence-case updates applied elsewhere.Line 19 was updated to lowercase "extension" per sentence-case capitalization, but line 49 retains "Command Line Interface" in title case. For consistency with the sentence-case style applied in this PR, line 49 should be updated to:
-### Method 2: Use Command Line Interface (CLI) +### Method 2: Use command line interface (CLI)en/docs/observe-and-manage/classic-observability-logs/configuring-log4j2-properties.md (2)
742-814: Clarify the Log4j2 plugin type name for custom appenders.Step 4 specifies
appender.log4j2Custom.type = Log4j2Appender. This appears to be a Java class name, but Log4j2'stypefield expects the plugin name (declared via the@Pluginannotation'snameparameter in the appender source code). All standard appenders in MI use plugin names likeConsoleandRollingFile, not class names. The documentation should clarify that developers must use the actual plugin name registered by their custom appender class, not the class name itself.The
<MI_HOME>/dropinsdirectory reference appears correct and is consistent with other MI custom components.
742-814: Clarify that the Maven XML snippet uses ellipsis placeholder notation; consider showing complete tag closure for clarity.The Maven snippet intentionally abbreviates the
<plugins>block using...to indicate context. This follows standard documentation convention, but readers may be confused about proper nesting. The fragment's Fragment-Host value (org.ops4j.pax.logging.pax-logging-log4j2), deployment directory (<MI_HOME>/dropins), and plugin configuration are correct and align with WSO2 Micro Integrator custom appender requirements.To improve clarity: Either (a) add an explicit note that these blocks nest within an existing
<plugins>section, or (b) show the complete closing tags at least once (e.g.,</executions>,</plugin>,</plugins>) to make the nesting structure explicit for readers unfamiliar with XML ellipsis conventions. Consider also adding explicit groupId tomaven-compiler-pluginfor reproducibility (e.g.,<groupId>org.apache.maven.plugins</groupId>).en/docs/observe-and-manage/classic-observability-traces/monitoring-with-opentelemetry-mi.md (4)
212-213: Fix typo/extra parenthesis in component name (“SysoutExporter)”).
This reads like a copy/paste slip and looks unprofessional in docs.-... let’s create a SysoutExporter) as below ... +... let’s create a SysOutExporter as below ...
7-7: PR objective alignment: several headings still look Title Cased.
If this PR’s goal is sentence-style capitalization, consider updating headings like:
- “OpenTelemetry Configurations for MI”, “Enabling Jaeger Tracing”, “Enabling Zipkin Tracing”, “Enabling Log Tracing”, “Enabling OTLP Tracing”
…to sentence case (e.g., “OpenTelemetry configurations for MI”, “Enabling Jaeger tracing”, etc.).
Also applies to: 32-32, 67-67, 101-101, 133-133, 188-188
188-205: Fix typo in package name and inconsistent method name formatting.Lines 192 and 384 contain a typo:
org.apache.syanpseshould beorg.apache.synapse(this is confirmed by the correct spelling used elsewhere in the document at line 345 and in the referenced GitHub repository link).Additionally, line 200 refers to "The close method" without backticks, inconsistent with other method references in the same list (
init,getTelemetryTracer,getServiceName,getHandler). Format it as`close`for consistency and also correct "shutdown" to "shut down" (two words for the phrasal verb).Proposed edit:
- Implement the `org.apache.syanpse.flow.statistics.tracing.opentelemetry.management.OpenTelemetryManager` interface and add your implementation. + Implement the `org.apache.synapse.flow.statistics.tracing.opentelemetry.management.OpenTelemetryManager` interface and add your implementation. - The close method should close the initialized `SdkTraceProvider` instance to shutdown the SDK cleanly at JVM exit. + The `close` method should close the initialized `SdkTraceProvider` instance to shut down the SDK cleanly at JVM exit. Also, in the custom tracer class, a method should be implemented to return those properties that will be similar to the method `getHeaderKeyProperty` in `OTLPTelemetryManager` class and the constant of `org.apache.syanpse.flow.statistics.tracing.opentelemetry.management.TelemetryConstants` class also needs to be changed according to the name given. + Also, in the custom tracer class, a method should be implemented to return those properties that will be similar to the method `getHeaderKeyProperty` in `OTLPTelemetryManager` class and the constant of `org.apache.synapse.flow.statistics.tracing.opentelemetry.management.TelemetryConstants` class also needs to be changed according to the name given.
343-382: Config/property schema is internally inconsistent (name/valuevsheader/key).The documentation shows two different property schemas for
[[opentelemetry.properties]]:
- Lines 147-150: Uses
nameandvaluefields- Lines 379-382: Uses
headerandkeyfieldsBoth array definitions cannot be correct. Unify to a single schema throughout the page to match what MI actually supports, otherwise users will configure the wrong keys.
🧹 Nitpick comments (7)
en/docs/get-started/build-first-integration/first-integration-connect-saas.md (1)
328-328: Remove trailing spaces after the heading to avoid unintended hard breaks.
Line 328 ends with two spaces (## What's next?␠␠), which can force a hard line break in Markdown renderers; suggest removing unless intentionally relied upon.-## What's next? +## What's next?en/docs/develop/deploy-artifacts.md (1)
5-5: Sentence-case heading change looks correct and matches the stated style guide.Minor consistency follow-up: other headings in this file (e.g., “Build and Export the Carbon Application”, “Build Docker image”) appear to use different casing; consider normalizing them too if they’re in scope for this PR. Keep “Build and Run” in bold as-is where it refers to the actual UI button label (Line 17).
en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md (1)
7-7: Fix minor Markdown/admonition formatting + casing consistency.
- Line 7: missing space after
#(#WSO2 ...) can render incorrectly; should be# WSO2 ....- Line 83:
!!!infotypically should be!!! info, and"What's Next?"likely should be sentence case ("What's next?") to match this PR’s stated goal.-#WSO2 Integrator: MI for VS Code Overview +# WSO2 Integrator: MI for VS Code Overview @@ -!!!info "What's Next?" +!!! info "What's next?"Also applies to: 83-83
en/docs/develop/customizations/creating-custom-task-scheduling.md (1)
17-20: Keep sentence case consistent in the accompanying prose (not just headings).
Line 19 and Line 25 still use title case (“Java Package”, “Java Class”, “Maven Project”) right after switching the headings to sentence case; consider updating those phrases to sentence case unless they’re intended as exact UI labels.Also applies to: 23-26
en/docs/get-started/event-driven-integrations.md (1)
40-40: Update reference text to match updated heading.Line 40 contains the reference text "Create the Topics" which still displays the old title case, but the heading at line 60 is now "Create the topics" in sentence case. For consistency, consider updating the display text to match the heading.
-continue from [Create the Topics](#create-the-topics). +continue from [Create the topics](#create-the-topics).en/docs/observe-and-manage/classic-observability-logs/configuring-log4j2-properties.md (1)
742-814: Minor consistency nits in the new section (readability/accuracy)
- “cloud storages” → “cloud storage” (or “cloud storage services”).
- Use “OSGi” (capitalization) consistently (currently “OSGi” vs “OSgi”).
- Step 5:
appenders = log4j2Custom, ....→ preferappenders = log4j2Custom, ...or show a concrete example including existing appenders.en/docs/observe-and-manage/classic-observability-traces/monitoring-with-opentelemetry-mi.md (1)
214-270: Java snippet: correctness hazards (raw Iterator, resource handling, and exporter lifecycle).
A few things here are likely to mislead users copying this code:
- Use generics (
Iterator<SpanData>) and avoid casts.JsonGenerator/StringWritershould be closed with try-with-resources (current code can leak on exceptions).shutdown()/flush()always returning success may be OK for a toy exporter, but the doc should call that out as “example only”.Minimal safer snippet shape:
-Iterator iterator = spans.iterator(); +Iterator<SpanData> iterator = spans.iterator(); ... -SpanData span = (SpanData) iterator.next(); +SpanData span = iterator.next(); ... -StringWriter writer = new StringWriter(); -JsonGenerator generator = this.jsonFactory.createGenerator(writer); +try (StringWriter writer = new StringWriter(); + JsonGenerator generator = this.jsonFactory.createGenerator(writer)) { ... - generator.close(); - writer.close(); System.out.println(writer.toString()); -} catch (IOException e) { +} catch (IOException e) {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (35)
en/docs/develop/advanced-development/changing-the-endpoint-of-deployed-service.md(2 hunks)en/docs/develop/creating-artifacts/creating-a-proxy-service.md(1 hunks)en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md(1 hunks)en/docs/develop/creating-artifacts/creating-reusable-sequences.md(1 hunks)en/docs/develop/creating-artifacts/creating-sequence-templates.md(1 hunks)en/docs/develop/customizations/ballerina-module/overview.md(1 hunks)en/docs/develop/customizations/creating-custom-task-scheduling.md(1 hunks)en/docs/develop/deploy-artifacts.md(1 hunks)en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md(1 hunks)en/docs/develop/wso2-integration-studio.md(2 hunks)en/docs/get-started/build-first-ai-integration/first-integration-ai-agent.md(1 hunks)en/docs/get-started/build-first-ai-integration/first-integration-ai-chatbot.md(1 hunks)en/docs/get-started/build-first-ai-integration/first-integration-knowledge-base.md(1 hunks)en/docs/get-started/build-first-ai-integration/first-integration-rag-chat.md(1 hunks)en/docs/get-started/build-first-ai-integration/index.md(1 hunks)en/docs/get-started/build-first-integration/first-integration-api-service.md(1 hunks)en/docs/get-started/build-first-integration/first-integration-connect-saas.md(1 hunks)en/docs/get-started/build-first-integration/first-integration-monitor-icp.md(1 hunks)en/docs/get-started/build-first-integration/first-integration-route-and-transform.md(1 hunks)en/docs/get-started/build-first-integration/index.md(1 hunks)en/docs/get-started/event-driven-integrations.md(2 hunks)en/docs/install-and-setup/install/installing-integration-control-plane.md(1 hunks)en/docs/install-and-setup/install/installing-mi.md(1 hunks)en/docs/install-and-setup/setup/deployment-best-practices/changing-the-default-ports-with-offset.md(1 hunks)en/docs/learn/examples/protocol-switching/switching-from-ftp-listener-to-mail-sender.md(1 hunks)en/docs/learn/examples/protocol-switching/switching-from-https-to-jms.md(1 hunks)en/docs/learn/examples/protocol-switching/switching-from-jms-to-http.md(1 hunks)en/docs/mi-analytics/mi-elk-dashboards.md(1 hunks)en/docs/observe-and-manage/classic-observability-logs/configuring-log4j2-properties.md(2 hunks)en/docs/observe-and-manage/classic-observability-traces/monitoring-with-opentelemetry-mi.md(1 hunks)en/docs/observe-and-manage/cloud-native-observability-overview.md(1 hunks)en/docs/observe-and-manage/setting-up-cloud-native-observability-in-kubernetes.md(1 hunks)en/docs/observe-and-manage/setting-up-cloud-native-observability-on-a-vm.md(1 hunks)en/docs/observe-and-manage/working-with-integration-control-plane.md(1 hunks)en/docs/reference/connectors/why-connectors.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
en/docs/develop/customizations/creating-custom-task-scheduling.md
21-21: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (40)
en/docs/get-started/build-first-ai-integration/first-integration-ai-agent.md (1)
432-432: Sentence-case heading change looks correct; please ensure no inbound anchor links break.This aligns with the PR goal (“What’s Next?” → “What’s next?”). If your site generator derives heading IDs/slugs from the raw text, confirm any inbound deep links (or ToC entries) still resolve after this change.
en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md (1)
49-49: Sentence-case heading change looks correct. The update to## Project overviewmatches the stated style guide direction.en/docs/get-started/build-first-ai-integration/first-integration-knowledge-base.md (2)
321-321: Header capitalization follows sentence-case style.The change from "What's Next?" to "What's next?" correctly applies sentence-case capitalization per the Microsoft Writing Style Guide, aligning with the PR objectives.
326-328: Navigation block addition is appropriate.The new HTML navigation button provides helpful context for users to proceed to the next tutorial and uses consistent template variable syntax (
{{base_path}}) matching other links in the document. The flexbox styling is reasonable for centering the button element.en/docs/get-started/build-first-ai-integration/first-integration-ai-chatbot.md (2)
285-285: Heading capitalization updated to sentence case.The change from "What's Next?" to "What's next?" aligns with the PR objective of following Microsoft Writing Style Guide for sentence-style capitalization in documentation headings. This is a purely cosmetic style change with no impact on functionality or content meaning.
1-292: Note on AI summary inconsistency.The AI-generated summary mentions "Two headings containing 'What's Next?' were updated," but only one heading change (line 285) is visible in the provided code. Please verify whether there is a second heading change in this file or if the summary is describing changes across multiple files in the PR.
en/docs/get-started/build-first-integration/first-integration-route-and-transform.md (1)
391-391: Heading capitalization change aligns with PR objective.The heading update on line 391 from "What's Next?" to "What's next?" correctly applies sentence-case capitalization per the Microsoft Writing Style Guide, consistent with the PR's stated purpose and the existing heading style throughout this document.
en/docs/get-started/build-first-integration/first-integration-monitor-icp.md (2)
146-150: Sentence-case heading and concluding paragraph look good.The heading change from "What's Next?" to "What's next?" (line 146) correctly applies sentence-case capitalization per the Microsoft Writing Style Guide. The new concluding paragraph (lines 148-150) flows naturally from the preceding congratulations message and provides clear, actionable guidance for users to continue their learning journey.
146-150: Verify the AI summary's claim of two heading changes.The AI summary mentions "Two headings containing 'What's Next?' were changed to 'What's next?' (case normalization) at two locations," but only one heading change is visible in the provided code (line 146). Please verify whether there is another "What's Next?" heading earlier in this file that was also updated but not shown in the annotated code.
en/docs/develop/wso2-integration-studio.md (1)
12-12: Documentation heading capitalization correctly updated to follow Microsoft Writing Style Guide.The changes consistently apply sentence-case capitalization to the section headings:
- Line 12: "Getting started" (changed from "Getting Started")
- Line 132: "What's next?" (changed from "What's Next?")
These conform to the sentence-style capitalization standard where only the first word and proper nouns are capitalized. Additionally, the new link on line 136 to "Troubleshooting WSO2 Integration Studio" enhances navigation consistency and provides helpful cross-reference value. The body text appropriately preserves references to UI element names (e.g., "Getting Started" view) to distinguish them from section headings.
Also applies to: 132-132, 136-136
en/docs/develop/advanced-development/changing-the-endpoint-of-deployed-service.md (2)
13-13: Heading sentence-case change looks good.
119-123: Dev headings are consistent with sentence case (“dev” lowercased).en/docs/mi-analytics/mi-elk-dashboards.md (1)
126-126: Heading case change aligns with PR objectives.The update from "Creating Advanced Dashboards" to "Creating advanced dashboards" correctly applies sentence-case capitalization per the Microsoft Writing Style Guide, which is consistent with the PR's stated purpose.
en/docs/learn/examples/protocol-switching/switching-from-https-to-jms.md (1)
38-38: Heading capitalization correctly applied.The change from "Build and Run" to "Build and run" correctly follows sentence-case capitalization per the Microsoft Writing Style Guide. The anchor reference at line 9 is already consistent with this format.
en/docs/learn/examples/protocol-switching/switching-from-jms-to-http.md (1)
40-40: Heading capitalization correctly applied.The change from "Build and Run" to "Build and run" correctly follows sentence-case capitalization per the Microsoft Writing Style Guide. The anchor reference at line 7 is already consistent with this format.
en/docs/learn/examples/protocol-switching/switching-from-ftp-listener-to-mail-sender.md (2)
49-49: Heading capitalization correctly applied.The change from "Build and Run" to "Build and run" correctly follows sentence-case capitalization per the Microsoft Writing Style Guide. The anchor reference at line 9 is already consistent with this format.
49-76: Approve content expansion for Build and Run section.The expanded Build and Run section enhances the documentation with detailed procedural steps, back-end service setup instructions, and platform-specific execution examples. The external include reference and structured workflow are consistent with similar examples in the PR.
en/docs/get-started/build-first-ai-integration/first-integration-rag-chat.md (1)
204-204: Sentence-case heading correctly applied.The change from "What's Next?" to "What's next?" follows sentence-style capitalization as per the Microsoft Writing Style Guide and aligns with the PR objective. The heading is now consistent with other similarly styled headings in the file (e.g., "What you'll build" and "What you'll learn").
en/docs/develop/customizations/ballerina-module/overview.md (1)
12-12: Heading capitalization updates look good.The sentence-case conversions on lines 12 and 19 correctly maintain proper nouns and acronyms (e.g., "Ballerina", "MI", "WSO2") while lowercasing common descriptive terms per the Microsoft Writing Style Guide.
Once line 49 is aligned, verify that all related headings in this file and across the broader documentation follow the same sentence-case capitalization pattern consistently.
Also applies to: 19-19
en/docs/get-started/event-driven-integrations.md (2)
60-60: Correct sentence-case application to heading.The heading change from "Create the Topics" to "Create the topics" correctly applies sentence-case capitalization per the Microsoft Writing Style Guide. The heading slug generated by Markdown will match the anchor referenced at line 40.
412-412: Correct sentence-case application to heading.The heading change from "What's Next?" to "What's next?" properly applies sentence-case capitalization. The change aligns with the documentation's existing style for similar section headings.
en/docs/observe-and-manage/cloud-native-observability-overview.md (1)
107-107: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/install-and-setup/install/installing-integration-control-plane.md (1)
147-147: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/observe-and-manage/setting-up-cloud-native-observability-in-kubernetes.md (1)
665-665: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/install-and-setup/setup/deployment-best-practices/changing-the-default-ports-with-offset.md (1)
75-75: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/observe-and-manage/working-with-integration-control-plane.md (1)
54-54: Heading capitalization follows sentence-case style correctly.The change from "Using the Integration Control Plane" to "Using the integration control plane" properly applies sentence-case capitalization. In sentence case, only the first word and proper nouns are capitalized; common nouns like "integration control plane" are correctly lowercased. Aligned with Microsoft Writing Style Guide.
en/docs/observe-and-manage/setting-up-cloud-native-observability-on-a-vm.md (1)
419-419: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/install-and-setup/install/installing-mi.md (1)
120-120: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/reference/connectors/why-connectors.md (1)
45-45: Heading capitalization follows sentence-case style correctly.The change from "What's Next?" to "What's next?" aligns with sentence-case capitalization per the Microsoft Writing Style Guide. No issues detected.
en/docs/get-started/build-first-integration/first-integration-api-service.md (1)
184-184: Heading capitalization aligns with sentence-case style guide.The change from "What's Next?" to "What's next?" is correct and properly applies sentence-case conventions while preserving the question mark.
en/docs/get-started/build-first-ai-integration/index.md (2)
26-26: Heading capitalization is correct.The change from "Get Started" to "Get started" properly applies sentence-case style.
30-32: New navigation button block: Verify link path exists.The HTML structure and styling are consistent and well-formatted. Ensure the linked path
{{base_path}}/get-started/build-first-ai-integration/first-integration-ai-chatbot/exists in your docs structure.en/docs/get-started/build-first-integration/index.md (2)
23-23: Heading capitalization is correct.The change from "Get Started" to "Get started" properly applies sentence-case style.
27-29: New navigation button block: Verify link path exists.The HTML structure and styling are consistent with similar patterns in the docs. Ensure the linked path
{{base_path}}/get-started/build-first-integration/first-integration-api-service/exists in your docs structure.en/docs/observe-and-manage/classic-observability-logs/configuring-log4j2-properties.md (1)
742-742: Heading sentence-case changes look good and consistent with the stated goal.Also applies to: 815-817
en/docs/develop/creating-artifacts/creating-sequence-templates.md (1)
7-7: Heading capitalization update is correct.The change correctly applies sentence-style capitalization by capitalizing only the first word and proper nouns. The update aligns with Microsoft Writing Style Guide standards.
en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md (1)
80-80: Heading capitalization update is correct.The change correctly applies sentence-style capitalization by capitalizing only the first word and proper nouns. Consistent with the broader documentation update initiative.
en/docs/develop/creating-artifacts/creating-a-proxy-service.md (2)
65-65: Heading capitalization update is correct.The change correctly applies sentence-style capitalization by capitalizing only the first word and proper nouns.
67-73: Content addition goes beyond the stated PR scope.The PR objective specifies updating heading capitalization per Microsoft Style Guide. However, lines 67-73 introduce substantial new content—explanatory text, image references, and descriptive passages—rather than just capitalization adjustments. This content expansion appears inconsistent with the PR's stated purpose.
Please clarify whether this content addition is intentional as part of this PR or should be separated into a distinct change. If intentional, consider updating the PR description to reflect the scope of documentation expansion.
en/docs/observe-and-manage/classic-observability-traces/monitoring-with-opentelemetry-mi.md (1)
274-336: Type mismatch ingetHandler()method return type.
Fieldprivate SpanHandler handler;(line 281) is returned by methodpublic OpenTelemetrySpanHandler getHandler()(line 332), but the field type does not match the declared return type. This will not compile unlessSpanHandlerimplements/extendsOpenTelemetrySpanHandler. Align the field type with the method return type to ensure the example code is correct and compilable.
| You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration. | ||
|
|
||
| ### Use the Source View | ||
| ### Use the source view |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cd en/docs/develop/creating-artifacts && head -85 creating-reusable-sequences.md | tail -15Repository: wso2/docs-mi
Length of output: 885
🏁 Script executed:
cat -n en/docs/develop/creating-artifacts/creating-reusable-sequences.md | sed -n '70,85p'Repository: wso2/docs-mi
Length of output: 1092
Fix broken anchor link to match heading text.
Line 76 contains an anchor link reference #using-the-source-view that doesn't match the heading at line 78 Use the source view (which generates #use-the-source-view). Update the anchor to fix the broken internal link:
- You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration.
+ You can also use the [**Source view**](#use-the-source-view) to update the sequence configuration.📝 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.
| You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration. | |
| ### Use the Source View | |
| ### Use the source view | |
| You can also use the [**Source view**](#use-the-source-view) to update the sequence configuration. | |
| ### Use the source view |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
76-76: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In en/docs/develop/creating-artifacts/creating-reusable-sequences.md around
lines 76 to 78, the internal anchor link uses `#using-the-source-view` but the
heading "Use the source view" generates `#use-the-source-view`; update the link
target to `#use-the-source-view` so the anchor matches the heading text and the
internal link works correctly.
| Create a Java Package inside the Maven Project using the following name: `org.wso2.task.stockquote.v1` | ||
| Create a Java Package inside the Maven Project using the following name: `org.wso2.task.stockquote.v1` | ||
|
|
||
|  |
There was a problem hiding this comment.
Add alt text to the image to satisfy MD045 and improve accessibility.
 should be .
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
21-21: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In en/docs/develop/customizations/creating-custom-task-scheduling.md around line
21, the image markdown is missing alt text which fails MD045 and reduces
accessibility; update the markup to include a meaningful alt description inside
the square brackets (e.g., describe the image content or purpose) so it becomes
.
1 participant
Updated multiple documentation headings to follow sentence-style capitalization according to the Microsoft Writing Style Guide. This includes adjusting capitalization, fixing improper casing, and ensuring consistency across the docs.
Purpose
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.