Skip to content

Minor documentation Issues in Cosmo Cloud Onboarding Guide: Incorrect Routing URL and Misleading Playground Behavior #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raosudheesh opened this issue May 10, 2025 · 0 comments · May be fixed by #68

Comments

@raosudheesh
Copy link

Description:

There are two minor issues in the Cosmo Cloud Onboarding documentation that can cause confusion for users trying to follow the guide.

Issues Identified:

1. Unexpected Redirect When Opening Playground:

In the section "Open the Playground", the instructions say:

Open http://localhost:3002/ and run your first GraphQL operation with WunderGraph Cosmo!

However, clicking or navigating to http://localhost:3002 redirects the user to http://localhost:3002/graphql, which is incorrect as the playground will be running at http://localhost:3002.

Proposed Fix:

Update the redirect URL path to http://localhost:3002

2. Incorrect Routing URL in Subgraph Creation:

In the Employee section of the guide, the following command is shown:

wgc subgraph create employees \
    --namespace development \
    --routing-url https://employee-api.fly.dev/graphql

The URL https://employee-api.fly.dev/graphql is invalid or unreachable.

Correct URL:
It should be: https://employees-api.fly.dev/graphql (with a plural employees).

Proposed Fix:
Update the CLI command in the documentation to:

wgc subgraph create employees \
    --namespace development \
    --routing-url https://employees-api.fly.dev/graphql

Context:

These issues were encountered while following the official Cosmo Cloud Onboarding guide. They may cause unnecessary troubleshooting for first-time users trying to get the router and subgraphs working correctly. Addressing them would streamline onboarding and reduce confusion.

raosudheesh pushed a commit to raosudheesh/cosmo-docs that referenced this issue May 10, 2025
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 a pull request may close this issue.

1 participant