rizinorg/cutter

Ideas for improving documentation

Open

#744 aperta il 1 ott 2018

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)C++ (1123 fork)batch import
DocumentationEnhancementHacktoberFestgood first issue

Metriche repository

Star
 (14.852 star)
Metriche merge PR
 (Merge medio 13g 23h) (20 PR mergiate in 30 g)

Descrizione

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

Guida contributor