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

Delete the wiki? #174

Open
johnomotani opened this issue Dec 18, 2023 · 1 comment
Open

Delete the wiki? #174

johnomotani opened this issue Dec 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@johnomotani
Copy link
Collaborator

The troubleshooting information from the wiki (https://github.com/boutproject/hypnotoad/wiki) has now been included in the manual (sections https://hypnotoad.readthedocs.io/en/stable/tips-and-tricks.html and https://hypnotoad.readthedocs.io/en/stable/nonorthogonal-tips.html). It's probably not good to have multiple places for information - it's harder to search and harder to keep up to date. Options:

  1. Delete the wiki (it would be good if someone could check that anything in the wiki that might be useful has made it into the manual). Additions and further tips should just be added to the manual (and can be discussed/refined while reviewing a PR).
  2. Remove the information that is included in the manual from the wiki, but keep the wiki as a more informal place for collecting tips and tricks to be written up in the manual at some point in the future if they are useful.

Any preferences or other options? I'd probably vote for 1 because having more than one place to look for stuff is bad.

@johnomotani johnomotani added the documentation Improvements or additions to documentation label Dec 18, 2023
@bendudson
Copy link
Contributor

I vote for option 1 (delete the wiki): In addition to your points, the wiki content is only available through Github. The manual is updated with the repository which I think is better.

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
Projects
None yet
Development

No branches or pull requests

2 participants