search

0no-co / gql.tada

🪄 Magical GraphQL query engine for TypeScript
https://gql-tada.0no.co
MIT License
2.56k stars 43 forks source link

docs: Add header hint for `generate-schema` to "Workflows" page #322

Closed sistrall closed 2 months ago

sistrall commented 3 months ago

Summary

When starting with gql.data, I spent quite some time trying to understand how to retrieve the schema without leaking API tokens in tsconfig.json.

Set of changes

This is the solution I'm using in my projects. It proves to be quite effective and even simple, despite the convoluted usage of single and double quotes required to control when shell interpolates the variable.

It uses the dotenv command, which is pretty common to have in dev dependencies.

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 2e756c345de62864507b88678f1c9a5ab4cd0fe6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

kitten commented 3 months ago

I don't think this is the right place for this per se. I think this could fit into a folded section of this doc's section however: https://gql-tada.0no.co/get-started/workflows#downloading-schemas

I'm a bit hesitant to say it should include an exact script recommendation, since that's not relevant. Further, I'm not sure it makes sense to show the bash wrapper, since it's not applicable to Windows in its current form. Not sure quite yet

sistrall commented 3 months ago

Thank you @kitten

I moved the info to the doc you suggested.