chore(docs): fix typo in README.md for simple-router example#2228
chore(docs): fix typo in README.md for simple-router example#2228StarpTech merged 1 commit intowundergraph:mainfrom
Conversation
WalkthroughUpdated 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
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 |
There was a problem hiding this comment.
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
📒 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.
graphql.yamltograph.yamlwhen describing the file containing subgraphs for the federated schema.Summary by CodeRabbit