Skip to content

chore(docs): fix typo in README.md for simple-router example#2228

Merged
StarpTech merged 1 commit intowundergraph:mainfrom
rsi2m:patch-1
Sep 18, 2025
Merged

chore(docs): fix typo in README.md for simple-router example#2228
StarpTech merged 1 commit intowundergraph:mainfrom
rsi2m:patch-1

Conversation

@rsi2m
Copy link
Copy Markdown
Contributor

@rsi2m rsi2m commented Sep 17, 2025

  • Documentation fix:
    • Changed the reference from graphql.yaml to graph.yaml when describing the file containing subgraphs for the federated schema.

Summary by CodeRabbit

  • Documentation
    • Corrected the schema filename reference from “graphql.yaml” to “graph.yaml” in the router-simple example, updating the corresponding anchor.
    • Cleaned up minor formatting by removing a stray annotation and ensuring a proper trailing newline.
    • Improves clarity for users modifying the schema and reduces confusion during setup.
    • No functional changes or behavior impacts.

@rsi2m rsi2m requested review from a team as code owners September 17, 2025 18:46
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 17, 2025

Walkthrough

Updated documentation in examples/router-simple/README.md: changed a schema file reference from graphql.yaml to graph.yaml (and its anchor), removed an annotation about missing newline, and ensured a trailing newline. No code or behavior changes.

Changes

Cohort / File(s) Change summary
Docs update
examples/router-simple/README.md
Updated schema filename and anchor from graphql.yaml to graph.yaml; removed “No newline at end of file” note; added trailing newline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title concisely and accurately describes the primary change — a documentation typo fix in the simple-router example README. It aligns with the changeset which updates the referenced schema filename from graphql.yaml to graph.yaml, so it reflects the main intent of the PR.
✨ Finishing touches
  • 📝 Generate Docstrings

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (1)
examples/router-simple/README.md (1)

44-44: Fix typos/grammar: “serverless” and preposition.

Change “severless” → “serverless”; “on a … environment” → “in a … environment”. Optional tense tightening below.

-For demonstration purposes, all subgraphs are running on a severless environment. The Cosmo Router is running locally and proxies the requests to the remote services. It might take a few seconds for the serverless functions to start up.
+For demonstration purposes, all subgraphs run in a serverless environment. The Cosmo Router runs locally and proxies requests to the remote services. It might take a few seconds for the serverless functions to start up.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a55be8 and 319bc6d.

📒 Files selected for processing (1)
  • examples/router-simple/README.md (1 hunks)
🔇 Additional comments (1)
examples/router-simple/README.md (1)

41-41: LGTM — corrected link to graph.yaml.

Verified: examples/router-simple/README.md (line 41) references graph.yaml; examples/router-simple/graph.yaml exists; no occurrences of "graphql.yaml" found repo-wide.

Copy link
Copy Markdown
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

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

LGTM

@StarpTech StarpTech changed the title 📚docs(README) Fix typo in README.md for simple-router example chore(docs): fix typo in README.md for simple-router example Sep 18, 2025
@StarpTech StarpTech merged commit b696681 into wundergraph:main Sep 18, 2025
7 of 9 checks passed
@Noroth Noroth mentioned this pull request Sep 30, 2025
5 tasks
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