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

Doc refinement #18

Merged
merged 2 commits into from
Mar 25, 2024
Merged

Doc refinement #18

merged 2 commits into from
Mar 25, 2024

Conversation

wuwwen
Copy link
Collaborator

@wuwwen wuwwen commented Feb 1, 2024

It's to create a workflow to build docs. And make a nicely introduction page.

Copy link
Collaborator

@ryan-kipawa ryan-kipawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I assume you tested the docs action. After it's merged, we should include a link to the docs in the "About" section


## Where can I get help?
* General help, new ideas and feature requests - [GitHub Discussions](http://github.com/DHI/mikepluspy/discussions)
* Bugs - [GitHub Issues](https://github.com/DHI/mikepluspy/issues)


## Getting started
Copy link
Collaborator

@ryan-kipawa ryan-kipawa Feb 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section (getting started) should show users how to do something useful in 3-4 lines of code.

Maybe add an example of updating a pipe diameter?

@wuwwen wuwwen merged commit bd873b2 into main Mar 25, 2024
1 check passed
@wuwwen wuwwen deleted the DocRefine branch March 28, 2024 05:47
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

Successfully merging this pull request may close these issues.

2 participants