Skip to content

docs: improve readmes - #17

Merged
mvantellingen merged 6 commits into
mainfrom
docs/readme
Oct 26, 2026
Merged

mvantellingen merged 6 commits into
mainfrom
docs/readme

Conversation

@mvantellingen

Copy link
Copy Markdown
Member

Summary

  • Add a root README.md: package table with npm badges, requirements, usage, development and release process.
  • Rewrite the package READMEs (bruno, k6, typedefs): what they generate and why, installation, a complete codegen.ts, every config option with type and default, real example output, and notes/limitations.
  • Remove the root .nvmrc (no workflow uses node-version-file; the jobs use the pnpm-install action's node-version input / default).
  • Patch changeset for the three packages, since the READMEs ship in the npm tarballs.

Verification

All snippets were run against a small schema with the locally built packages and @graphql-codegen/cli 7.4.6; the example output in the READMEs is the real output (trimmed where noted). The k6 SDK and example script were type checked, bundled with esbuild and run with k6 against a mock GraphQL server. The typedefs output was loaded with makeExecutableSchema.

Behaviour documented as limitations

  • k6: the default documentMode: "graphQLTag" generates a Requester type that uses DocumentNode without importing it, and documentMode: "string" references an undefined TypedDocumentString. The README recommends documentMode: "documentNode".
  • bruno: the request body contains the full source document, so several operations in one .graphql file all end up in each request (and fragments in that file appear twice). clean: true empties the whole output directory.

@mvantellingen
mvantellingen merged commit 58552a7 into main Oct 26, 2026
6 checks passed
@mvantellingen
mvantellingen deleted the docs/readme branch October 26, 2026 06:14
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.

1 participant