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

Improve documentation in the README.md #84

Open

KyleJune opened this issue Jul 28, 2024 · 1 comment

Assignees

Labels

Member

KyleJune commented Jul 28, 2024

I need to come up with a more structured outline on how to get started with using this framework. Right now the documentation is pretty basic.

KyleJune added the documentation label

KyleJune self-assigned this

Member Author

KyleJune commented Jul 28, 2024

Here are some ideas for sections.

Creating API and UI routes
How to build
How to use dev server
How to deploy
Serving static files
Oak middleware
Logging
Configuration
Adding esbuild plugins
Adding context
Using react libraries
Rendering markdown or raw HTML
Testing
Examples

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