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

Removing WIP from docs #92

Open
thabaum opened this issue Nov 8, 2024 · 0 comments
Open

Removing WIP from docs #92

thabaum opened this issue Nov 8, 2024 · 0 comments

Comments

@thabaum
Copy link
Contributor

thabaum commented Nov 8, 2024

What areas are we going to need to focus on so we no longer call our Oqtane.Docs project a WIP?

This is always a WIP, but at this point with all the latest updates things seem fairly complete and just need enhanced for a majority of the documentation needed to work with Oqtane.

Current areas to focus for this WIP issue will be the following areas:
https://docs.oqtane.org/dev/modules/index.html

Creating Modules (WIP): Resources and guidelines for creating custom modules for Oqtane.
Developing Modules (WIP): Resources and guidelines for developing custom modules for Oqtane.
Module Deployment (WIP): Resources and guidelines for deploying custom modules for Oqtane.
Troubleshooting Module Development (WIP): Troubleshooting tips and solutions for common issues encountered with developing modules.

Also finish documenting the database models in the Oqtane.Framework repo:
https://github.com/oqtane/oqtane.framework/tree/dev/Oqtane.Shared/Enums
https://github.com/oqtane/oqtane.framework/tree/dev/Oqtane.Shared/Models

Which can be generated with information from here:
https://docs.oqtane.org/guides/database-management/database-schema.html

Using comments for each class enum/model in order to be displayed here:
https://docs.oqtane.org/api/Oqtane.Models.html

Also the API generator should create a link in the menu here:
image

The code format for auto generating the documentation in these areas can be enhanced further to allow these to be linked in the menu when generated.

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