Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dthyresson opened this issue Dec 8, 2022 · 0 comments

Comments

@dthyresson
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant