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

Debug arg parsing error while launching the app & Contribute Initial Documentation #307

Merged
merged 12 commits into from
Sep 4, 2024

Conversation

sora-ryu
Copy link
Collaborator

@sora-ryu sora-ryu commented Aug 1, 2024

Purpose

  1. Address the error mentioned on Viz tool integration #301
  2. Replace README.md with official documentation page

Type of change

What types of change is it?
Select the appropriate type(s) that describe this PR

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Explain the steps needed to test the new code to verify that it does indeed address the issue and produce the expected behavior.

Checklist

Put an x in the boxes that apply.

  • I have run existing tests which pass locally with my changes
  • I have added new tests or examples that prove my fix is effective or that my feature works
  • I have added necessary documentation

@sora-ryu sora-ryu marked this pull request as ready for review August 1, 2024 22:57
@sora-ryu sora-ryu changed the title Debug arg parsing error while launching the app Debug arg parsing error while launching the app & Contribute Initial Documentation Aug 2, 2024
@dzalkind
Copy link
Collaborator

dzalkind commented Aug 7, 2024

Thanks @sora-ryu! When you are ready to merge this, can you assign a reviewer?

@sora-ryu
Copy link
Collaborator Author

Documentation is finally ready to review! @dzalkind and @mayankchetan , please let me know if any further improvements would be needed.

@dzalkind
Copy link
Collaborator

How does this documentation work with the WEIS readthedocs that already exists?

@sora-ryu
Copy link
Collaborator Author

I thought we are having separate documentation for Viz tool. Do you want me to include it into existing WEIS docs?

@sora-ryu
Copy link
Collaborator Author

Added this WEIS Viz documentation to the existing WEIS documentation, not keeping separate.

Copy link
Collaborator

@mayankchetan mayankchetan 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 to me. Thank you for moving it to the main docs

@dzalkind dzalkind merged commit b651a8c into WISDEM:develop Sep 4, 2024
20 checks passed
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.

3 participants