Example docsadd anchor link in examples #2170
Conversation
WalkthroughDocumentation updates in distribution/examples: internal anchors added to distribution/examples/README.md links; multiple new README.md stubs created for example subdirectories; one heading level adjusted in security/access-control-list/README.md. No code or API changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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 |
|
This pull request needs "/ok-to-test" from an authorized committer. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (11)
distribution/examples/web-services-soap/README.md (1)
1-1: Add a short overview and a back-link to the examples index.A one‑sentence summary and a “Back to Examples” link improve discoverability and consistency with other example READMEs.
Apply this diff:
# Web Services with SOAP + +This section contains examples demonstrating SOAP service integration and mediation patterns. + +[← Back to Examples](../README.md)distribution/examples/orchestration/README.md (1)
1-1: Enrich with a brief description and index back-link.Helps readers understand scope and navigate back.
# Orchestration + +Examples showcasing request/response composition, fan‑out/fan‑in, and workflow-style orchestration. + +[← Back to Examples](../README.md)distribution/examples/xml/README.md (1)
1-1: Clarify scope and add navigation.Rename heading for clarity, add a one‑liner, and link back to the examples index.
-# XML +# XML Examples + +Examples illustrating XML processing, transformation, and routing. + +[← Back to Examples](../README.md)distribution/examples/validation/README.md (1)
1-1: Add a concise description and back-link.Provides context and consistent navigation.
# Message Validation + +Examples demonstrating schema/contract validation and policy enforcement for incoming/outgoing messages. + +[← Back to Examples](../README.md)distribution/examples/graphql/README.md (1)
1-1: Add a short intro and back-link for consistency.# GraphQL + +Examples covering GraphQL proxying, schema exposure, and query handling patterns. + +[← Back to Examples](../README.md)distribution/examples/message-transformation/README.md (1)
1-1: Add context and navigation.# Message Transformation + +Examples for mapping, enriching, filtering, and format conversion between protocols and payload types. + +[← Back to Examples](../README.md)distribution/examples/scripting/README.md (1)
1-1: Brief description + note supported runtimes + back-link.Consider listing supported scripting runtimes here (or link to them) and add navigation.
# Scripting + +Examples that use scripting to implement custom policies and transformations. + +Note: Consider adding a list (or link) of supported scripting runtimes for quick reference. + +[← Back to Examples](../README.md)Can you confirm which scripting runtimes you want to reference so we avoid stale details?
distribution/examples/monitoring-tracing/README.md (1)
1-1: Use clearer heading: “Monitoring and Tracing”.Improves readability and matches common terminology.
-# Monitoring Tracing +# Monitoring and Tracing + +Examples demonstrating metrics, logs, and distributed tracing integration. + +[← Back to Examples](../README.md)distribution/examples/deployment/README.md (1)
1-1: Consider adding more descriptive content to the README stub.This README currently contains only a heading. Since this appears to be part of a documentation restructuring effort, consider adding at least a brief description or overview of what users will find in this directory to improve discoverability and user experience.
# Deployment and Installation + +This directory contains examples demonstrating various deployment options and installation methods for the Membrane API Gateway.distribution/examples/websockets/README.md (1)
1-1: Add missing newline and expand the README content.The file is missing a trailing newline, which is a common convention. Additionally, like other README stubs in this PR, consider adding descriptive content to help users understand what examples are available in this directory.
-# Websockets +# Websockets + +This directory contains examples demonstrating WebSocket functionality with the Membrane API Gateway. +distribution/examples/routing-traffic/README.md (1)
1-1: Enhance the README stub with descriptive content.Similar to other README files in this PR, this stub would benefit from additional content describing what routing and traffic management examples are available in this directory.
# API Traffic Routing + +This directory contains examples demonstrating various API traffic routing capabilities of the Membrane API Gateway.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
distribution/examples/README.md(6 hunks)distribution/examples/deployment/README.md(1 hunks)distribution/examples/graphql/README.md(1 hunks)distribution/examples/message-transformation/README.md(1 hunks)distribution/examples/monitoring-tracing/README.md(1 hunks)distribution/examples/orchestration/README.md(1 hunks)distribution/examples/routing-traffic/README.md(1 hunks)distribution/examples/scripting/README.md(1 hunks)distribution/examples/security/access-control-list/README.md(1 hunks)distribution/examples/validation/README.md(1 hunks)distribution/examples/web-services-soap/README.md(1 hunks)distribution/examples/websockets/README.md(1 hunks)distribution/examples/xml/README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (java)
🔇 Additional comments (2)
distribution/examples/security/access-control-list/README.md (1)
1-1: LGTM! Heading level adjustment aligns with documentation structure.Changing from a level-3 heading (###) to a level-1 heading (#) makes sense for a standalone README file, as it establishes this as the primary document heading rather than a subsection.
distribution/examples/README.md (1)
5-5: Resolved — anchor links verified All referenced anchor fragments (e.g. #deployment-and-installation, #api-traffic-routing, #websockets, #access-control-interceptor) match the generated heading IDs in the corresponding distribution/examples/*/README.md files.
2 participants
Summary by CodeRabbit