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] FAQ, Contributing Guidelines, Wiki #2686

Open
JacksonBurns opened this issue Jun 23, 2024 · 4 comments
Open

[Documentation] FAQ, Contributing Guidelines, Wiki #2686

JacksonBurns opened this issue Jun 23, 2024 · 4 comments

Comments

@JacksonBurns
Copy link
Contributor

JacksonBurns commented Jun 23, 2024

There are a few places in the RMG documentation that need to be updated:

  • Our FAQ is quite outdated, offering advice ranging from unhelpful to wrong - we need to give it a once-over and make sure everything is UTD. See: https://reactionmechanismgenerator.github.io/RMG-Py/users/rmg/faq.html#installing-rmg (e.g. the Installing RMG section offers suggestions about Windows Binary installs, which we no longer support).
  • The Contributing guidelines in the wiki are hidden away from possible contributors and out of date - they should be modernized and a link to them should be added to the pull request template.
  • The contents of the Wiki should be moved to the documentation directory where still relevant, and deleted otherwise.

@jonwzheng and I are working on this!

@JacksonBurns JacksonBurns changed the title Update FAQ [Documentation] FAQ, Contributing Guidelines, Wiki Aug 6, 2024
@jonwzheng
Copy link
Contributor

Current plan is to move contributor guidelines to a CONTRIBUTE.md file, as described here.

@jonwzheng
Copy link
Contributor

jonwzheng commented Aug 6, 2024

edit: will track wiki update progress in main comment of PR #2703

Copy link

github-actions bot commented Nov 5, 2024

This issue is being automatically marked as stale because it has not received any interaction in the last 90 days. Please leave a comment if this is still a relevant issue, otherwise it will automatically be closed in 30 days.

@github-actions github-actions bot added the stale stale issue/PR as determined by actions bot label Nov 5, 2024
@JacksonBurns
Copy link
Contributor Author

This is still ongoing in the linked PRs - @jonwzheng looks like we need to get back at this!

@github-actions github-actions bot removed the stale stale issue/PR as determined by actions bot label Nov 6, 2024
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