Skip to content

Commit a521216

Browse files
authored
fix: broken links (#7581)
* fix: broken links * chore: changeset
1 parent e0c3ba5 commit a521216

File tree

5 files changed

+79
-84
lines changed

5 files changed

+79
-84
lines changed

‎.changeset/new-weeks-turn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@graphql-codegen/plugin-helpers': patch
3+
---
4+
5+
broken links within documentation

‎packages/utils/plugins-helpers/src/types.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ export namespace Types {
252252
/**
253253
* @description A flag to overwrite files if they already exist when generating code (`true` by default).
254254
*
255-
* For more details: https://graphql-code-generator.com/docs/getting-started/codegen-config
255+
* For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config
256256
*/
257257
overwrite?: boolean;
258258
/**
@@ -267,7 +267,7 @@ export namespace Types {
267267
*
268268
* You can specify either a single file, or multiple.
269269
*
270-
* For more details: https://graphql-code-generator.com/docs/getting-started/documents-field
270+
* For more details: https://graphql-code-generator.com/docs/config-reference/documents-field
271271
*/
272272
documents?: InstanceOrArray<OperationDocument>;
273273
/**
@@ -283,7 +283,7 @@ export namespace Types {
283283
*
284284
* You can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.
285285
*
286-
* For more details: https://graphql-code-generator.com/docs/getting-started/schema-field
286+
* For more details: https://graphql-code-generator.com/docs/config-reference/schema-field
287287
*/
288288
schema?: InstanceOrArray<Schema>;
289289
/**
@@ -292,14 +292,14 @@ export namespace Types {
292292
*
293293
* The options may vary depends on what plugins you are using.
294294
*
295-
* For more details: https://graphql-code-generator.com/docs/getting-started/config-field
295+
* For more details: https://graphql-code-generator.com/docs/config-reference/config-field
296296
*/
297297
config?: PluginConfig;
298298
/**
299299
* @description Specifies scripts to run when events are happening in the codegen core.
300300
* Hooks defined on that level will effect only the current output files.
301301
*
302-
* For more details: https://graphql-code-generator.com/docs/getting-started/lifecycle-hooks
302+
* For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks
303303
*/
304304
hooks?: Partial<LifecycleHooksDefinition>;
305305
}
@@ -356,14 +356,14 @@ export namespace Types {
356356
*
357357
* You can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.
358358
*
359-
* For more details: https://graphql-code-generator.com/docs/getting-started/schema-field
359+
* For more details: https://graphql-code-generator.com/docs/config-reference/schema-field
360360
*/
361361
schema?: InstanceOrArray<Schema>;
362362
/**
363363
* @description A path to a file which defines custom Node.JS require() handlers for custom file extensions.
364364
* This is essential if the code generator has to go through files which require other files in an unsupported format (by default).
365365
*
366-
* For more details: https://graphql-code-generator.com/docs/getting-started/require-field
366+
* For more details: https://graphql-code-generator.com/docs/config-reference/require-field
367367
* See more information about require.extensions: https://gist.github.com/jamestalmage/df922691475cff66c7e6.
368368
*
369369
* Note: values that specified in your .yml file will get loaded after loading the config .yml file.
@@ -386,7 +386,7 @@ export namespace Types {
386386
*
387387
* You can specify either a single file, or multiple.
388388
*
389-
* For more details: https://graphql-code-generator.com/docs/getting-started/documents-field
389+
* For more details: https://graphql-code-generator.com/docs/config-reference/documents-field
390390
*/
391391
documents?: InstanceOrArray<OperationDocument>;
392392
/**
@@ -397,21 +397,21 @@ export namespace Types {
397397
*
398398
* The options may vary depends on what plugins you are using.
399399
*
400-
* For more details: https://graphql-code-generator.com/docs/getting-started/config-field
400+
* For more details: https://graphql-code-generator.com/docs/config-reference/config-field
401401
*/
402402
config?: PluginConfig;
403403
/**
404404
* @description A map where the key represents an output path for the generated code and the value represents a set of options which are relevant for that specific file.
405405
*
406-
* For more details: https://graphql-code-generator.com/docs/getting-started/codegen-config
406+
* For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config
407407
*/
408408
generates: {
409409
[outputPath: string]: ConfiguredOutput | ConfiguredPlugin[];
410410
};
411411
/**
412412
* @description A flag to overwrite files if they already exist when generating code (`true` by default).
413413
*
414-
* For more details: https://graphql-code-generator.com/docs/getting-started/codegen-config
414+
* For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config
415415
*/
416416
overwrite?: boolean;
417417
/**
@@ -452,7 +452,7 @@ export namespace Types {
452452
/**
453453
* @description Allows you to override the configuration for `@graphql-tools/graphql-tag-pluck`, the tool that extracts your GraphQL operations from your code files.
454454
*
455-
* For more details: https://graphql-code-generator.com/docs/getting-started/documents-field#graphql-tag-pluck
455+
* For more details: https://graphql-code-generator.com/docs/config-reference/documents-field#graphql-tag-pluck
456456
*/
457457
pluckConfig?: {
458458
/**
@@ -481,7 +481,7 @@ export namespace Types {
481481
* @description Specifies scripts to run when events are happening in the codegen core.
482482
* Hooks defined on that level will effect all output files.
483483
*
484-
* For more details: https://graphql-code-generator.com/docs/getting-started/lifecycle-hooks
484+
* For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks
485485
*/
486486
hooks?: Partial<LifecycleHooksDefinition>;
487487
}

‎website/docs/integrations/prettier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Before adding a hook, consider the alternative of having codegen ignored in your
99
Codegen files should not be edited manually and formatting them slows down your codegen considerably.
1010
Differences can be measured in several seconds for every run on big projects.
1111

12-
[You can read the complete documentation of lifecycle hooks here](/docs/getting-started/lifecycle-hooks)
12+
[You can read the complete documentation of lifecycle hooks here](/docs/config-reference/lifecycle-hooks)
1313

1414
## Prettier
1515

‎website/next.config.js

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,41 @@ module.exports = withGuildDocs({
4242
destination: '/docs/config-reference/codegen-config',
4343
permanent: true,
4444
},
45+
{
46+
source: '/docs/getting-started/codegen-config',
47+
destination: '/docs/config-reference/codegen-config',
48+
permanent: true,
49+
},
50+
{
51+
source: '/docs/getting-started/documents-field',
52+
destination: '/docs/config-reference/documents-field',
53+
permanent: true,
54+
},
55+
{
56+
source: '/docs/getting-started/schema-field',
57+
destination: '/docs/config-reference/schema-field',
58+
permanent: true,
59+
},
60+
{
61+
source: '/docs/getting-started/config-field',
62+
destination: '/docs/config-reference/config-field',
63+
permanent: true,
64+
},
65+
{
66+
source: '/docs/getting-started/lifecycle-hooks',
67+
destination: '/docs/config-reference/lifecycle-hooks',
68+
permanent: true,
69+
},
70+
{
71+
source: '/docs/getting-started/require-field',
72+
destination: '/docs/config-reference/require-field',
73+
permanent: true,
74+
},
75+
{
76+
source: '/docs/getting-started/naming-convention',
77+
destination: '/docs/config-reference/naming-convention',
78+
permanent: true,
79+
},
4580
];
4681
},
4782
});

0 commit comments

Comments
 (0)