Skip to content
This repository was archived by the owner on Oct 16, 2025. It is now read-only.
This repository was archived by the owner on Oct 16, 2025. It is now read-only.

✨ - To kick start app documentation, add Self-Documentating GraphQL Api and Docusaurus #145

@dthyresson

Description

@dthyresson

Story

Documenting your project, database design, api is key for collaboration and getting new developers on the team up tp speed quickly.

But, setting up the structure for documentation can be cumbersome and time consuming.

Why not add it to the template so it's ready from the start!

And, thanks to some tooling, the app's GraphQL API can self-generate documentation for your types, operations, enums and more.

Acceptance Criteria

Design Implementation

The RedwoodJS GraphQL API documentation describes the setup which can be done once in the main template repo and then ready for use throughout the life ofd the project.

Notes

What's nice is that one can then deploy the docs site for feature, or design reviews, or for public consumption.

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