docs(wiki): improve the project wiki from the feedbacks
- Dominant language
- G-code
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
# Actions
- [ ] Read the feedbacks from [Cathal](Cathal)
- [ ] Add subheadings into developer documentation [e.g. hdf5, what kind of data is collected, more details of how to start the development]
# Tasks
- [ ] Improve the GitHub Wiki from the feedbacks
- [ ] HDF5
- [ ] What is this?
- [ ] Why this is needed?
- [ ] How would we can use this?
- [ ] Collected Data
- [ ] What are these?
- [ ] Why these are needed?
- [ ] How these could be collected?
- [ ] DataSets
- [ ] What are these?
- [ ] Why these are needed?
- [ ] How these could be stored and used?
- [ ] Zenodo
- [ ] What is this?
- [ ] Why this is needed?
- [ ] How would we can use this?
- [ ] ...not...sure...yet
- [ ] Add more from my notepad later
# Redirection
- GitHub-Wiki: [Wiki-Home](https://github.com/immjunjie/CS3300-Project/wiki)
- GitHub-Wiki: [Architecture-Simulator](https://github.com/immjunjie/CS3300-Project/wiki/For-Contributors-Project-Architecture-Simulator)
- Sub-Issues: #10
# Res & Ref
- [Main Res & Ref](https://github.com/immjunjie/CS3300-Project/wiki/For-Contributors-Resource#main-resources--references)
- [GitHub Wikis Documentation](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis)
- [How to write software documentation? - Writethedocs ](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/)
- [Library Guides: How to Write Good Documentation](https://guides.lib.berkeley.edu/how-to-write-good-documentation)
- [Learning GitHub - Making Wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.