DocumentationEnhancementHacktoberFestgood first issue
Métriques du dépôt
- Stars
- (14 852 stars)
- Métriques de merge PR
- (Merge moyen 13j 23h) (20 PRs mergées en 30 j)
Description
Our new documentation lies here: https://cutter.re/docs/ Many things are lacking, and some are not very well explained. It would be awesome if someone could complete the documentation, providing screenshots, etc
edited by @itayc0hen :
We are talking about creating a clear and easy-to-follow documentation for Cutter.
Including but not limited -
- Compilation tutorials
- Widgets description (with screenshots for better understanding)
- Shortcuts
- Settings explanation
- Common use cases
- Common Issues
- Cutter Limits
- How to contribute (opening issues, opening Pull Requests)
- Contributing guidelines (copy content from CONTRIBUTING.md)
As you can see on our website, we already have some pages such as Building, Common errors, Overview, Shortcuts that we want to improve as well as adding more.
I'd suggest you take inspiration from the Documentation of BinaryNinja: https://docs.binary.ninja/getting-started.html