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

5b Refactor long readme to wiki #51

Open
mezdahun opened this issue Nov 14, 2022 · 5 comments
Open

5b Refactor long readme to wiki #51

mezdahun opened this issue Nov 14, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@mezdahun
Copy link
Contributor

Current README is lengthy and is not scalable for multiple projects. Let's refactor the knowledge into the wiki instead.

@vagechirkov
Copy link
Collaborator

Great idea, let's do it! I think it would be helpful to document the simulation details and parameters. @DominikDeffner I think we can also describe the parameter ranges in this wiki to keep this information close to the simulation source code 😊

@vagechirkov vagechirkov added the documentation Improvements or additions to documentation label Nov 14, 2022
@DominikDeffner
Copy link

Great! Which wiki do you mean? Sorry, I was away for too long apparently haha

@vagechirkov
Copy link
Collaborator

vagechirkov commented Nov 14, 2022

Great! Which wiki do you mean? Sorry, I was away for too long apparently haha

I think the idea is to refactor the README into a GitHub wiki 🙂 See more information here: https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages

@DominikDeffner
Copy link

Ah cool, didn't know there is a Wiki option in GutHub

@vagechirkov
Copy link
Collaborator

Ah cool, didn't know there is a Wiki option in GutHub

I think this is a relatively new feature 🙂

@mezdahun mezdahun changed the title Refactor long readme to wiki 5b Refactor long readme to wiki Dec 20, 2022
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

3 participants