Skip to content

Suggestion: Some docs refer to output files rather than source files #55

@richardhauer

Description

@richardhauer

The QueryMap and MutationMap markdown docs refer to output files rather than source files.
See docs/modules/xmc/interfaces/QueryMap.md and docs/modules/xmc/interfaces/MutationMap.md

Both of these mention "Defined in: packages/client/dist/sdk-types.d.ts" but an arguably better reference would be packages/client/src/sdk-types.ts since we're in the source library and the file referred to doesn't actually exist here.

Creating an actual hyperlink to the correct source file is both more convenient for the consumer, and more forgiving for those not "in the know" who may not be able to translate the output path into the source path in their head.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions