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

Help wanted: Improve documentation #171

Open
lgrammel opened this issue Nov 12, 2023 · 2 comments
Open

Help wanted: Improve documentation #171

lgrammel opened this issue Nov 12, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lgrammel
Copy link
Collaborator

The ModelFusion documentation could be expanded to include more details and make it easier to understand. If you have suggestions or ideas, please contribute!

@lgrammel lgrammel added the help wanted Extra attention is needed label Nov 12, 2023
@lgrammel lgrammel pinned this issue Nov 12, 2023
@lgrammel lgrammel changed the title Improve documentation Help wanted: Improve documentation Nov 12, 2023
@erickNjuki
Copy link

erickNjuki commented Nov 14, 2023

@lgrammel I can help out.

We can start with an introduction to ModelFusion. After the introduction , we'll dive into the basics on the getting started page.

After that, we can organize the remaining content into four key sections:

  • Explanation Guides: break down and define the various concepts within ModelFusion.

  • How-to Guides: includes complex scenarios and provide guides on problem-solving.

  • Tutorials: This section will feature step-by-step guides, walking users through tasks using ModelFusion.

  • Reference Guides: serves as a comprehensive API documentation for easy reference.

@lgrammel
Copy link
Collaborator Author

@erickNjuki great - there is some existing structure already. The easiest way to get started could be by adding something more specific, e.g. creating a tutorial on something that hasn't been covered yet, or expanding an existing page in the guide. Have you e.g. used ModelFusion for something that you think could be interesting?

@lgrammel lgrammel added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants