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.

Sign up for GitHub

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

Jump to bottom

Choose Documentation Engine for SDK #20

Open

krvital opened this issue Aug 28, 2024 · 1 comment

Labels

type:documentation type:feature

Contributor

krvital commented Aug 28, 2024 •

edited

Loading

Select and implement a documentation engine for generating SDK documentation.

Requirements:

Design Reference: Follow the look and feel of Supabase and Slate documentation engines.
Features:
- Ability to generate a documentation site dynamically.
- Support for code examples in multiple languages with a switcher or similar user experience.
- Generate documentation for our SDK based on provided packages.

Implement a sample documentation site using the selected engine.

krvital changed the title ~~Choose Documentation Engine~~ Choose Documentation Engine for SDK

krvital added type:documentation type:feature labels

Contributor Author

krvital commented Aug 29, 2024

It seems that supabase uses docusarus for inner product documentation pages. So, maybe we need to try utilize docusaurus for our needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment