graphql-mesh icon indicating copy to clipboard operation
graphql-mesh copied to clipboard

Website documentation file JsonSchemaHandler.generated.md makes no sense

Open Woodz opened this issue 2 months ago • 1 comments

https://github.com/ardatan/graphql-mesh/blob/master/website/src/generated-markdown/JsonSchemaHandler.generated.md appears to be malformed and confusing:

Specifically:

  1. Parameters exposeResponseMetadata and argTypeMap are indented by 4 spaces which starts a code block, which does not look intentional
  2. The 2 Examples headings do not contain examples as far as I can tell

image

Since this is a generated file, I thought this was a bug in the generation process so therefore raising an MR to try to fix this one file was not sensible

Note: GitHub issue template is not applicable for website documentation so I removed it

Woodz avatar Apr 17 '24 03:04 Woodz

It is generated from this file; https://github.com/ardatan/graphql-mesh/blob/master/packages/legacy/handlers/json-schema/yaml-config.graphql by using this command; https://github.com/ardatan/graphql-mesh/blob/27a2855c54be9e6cc76b2c4c4603c97062bcb4c9/package.json#L45 So we need to fix it in this package, otherwise your changes will be gone after the next build; https://github.com/ardatan/graphql-mesh/blob/master/package.json#L62

ardatan avatar Apr 17 '24 07:04 ardatan