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

Documentation Issues #187

Closed
abachma2 opened this issue Feb 28, 2022 · 2 comments
Closed

Documentation Issues #187

abachma2 opened this issue Feb 28, 2022 · 2 comments

Comments

@abachma2
Copy link
Contributor

While looking through this repo I noticed a few things with the documentation:
[ ] The link to MOOSE wiki, tutorial, and examples are not working. I got a message that the links couldn't be found.
[ ] The Moltres page on the ARFC website have Alex Lindsey listed for dev questions. Should he be removed (I can also raise this issue in that repo if this needs to be updated)?
[ ] The Doxygen pages are very blank when I click on the link, and it's not obvious where to go
[ ] I would consider changing the name of the Nts module (I think it's a module). It's not intuitive on what that means.
[ ] Something should be added about tutorial/ directory to either the README or the wiki. The wiki contains an example from the tests directory, which doesn't seem like an intuitive place to pull an example from.
[ ] Add more description to the problems in tutorials/. Some of them have decent descriptions in their README, but not all are clear.
[ ] General pattern of more than 80 characters/line in the README's

@smpark7
Copy link
Collaborator

smpark7 commented Mar 1, 2022

Thanks for reviewing the Moltres repo! I'll address issues 1-3 in a PR today and create separate issues for 4-6. About issue 7, we follow the 100 character limit instead of the 80 limit.

@smpark7
Copy link
Collaborator

smpark7 commented Mar 1, 2022

I'm closing this issue because it has been either addressed by PRs #189 and #190, or expanded upon in issue #191.

@smpark7 smpark7 closed this as completed Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants