Skip to content

Improve documentation #23

@felipesabino

Description

@felipesabino
  • Add JSDoc's documentation to each decorator function and its option object
    • @UnionType
    • @InterfaceType
    • @EnumType + @Value
    • @Field + @Arg + @OrderBy
    • @ObjectType
    • @InputObjectType
    • @Query
    • @Mutation
    • @Subscription
    • @Schema
    • @Before
    • @Root
    • @UseContainer
    • @After
  • Improve README documentation
  • ❓ separate each decorator example and doc into its own file inside docs/ folder
  • Add a link reference to each example folder
  • Add a CHANGELOG.md file, instead of having release notes on the Releases tab
  • move CHANGELOG.md from docs folder to root

you can do it label

Instead of tacking all at decorators at once, which is just too huge and demanding, you can do several stuff just for one decorator, some options are:

  • You can pick one of the new ones (located at the top of the readme) and add its documentation in the current README style, that would already help a lot
  • You could just add some JSDoc documentation to the one of the decorators at src/decorator.ts or at their options object interface properties

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions