rizinorg/cutter

Ideas for improving documentation

Open

#744 opened on Oct 1, 2018

View on GitHub
 (9 comments) (0 reactions) (0 assignees)C++ (14,852 stars) (1,123 forks)batch import
DocumentationEnhancementHacktoberFestgood first issue

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

Contributor guide

Tech stack
cpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of CutterFamiliarity with markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by reviewing the current documentation at https://cutter.re/docs/. The issue lists several areas: Compilation tutorials, Widgets description, Shortcuts, etc. Focus on improving existing pages like Building, Common errors, Overview, Shortcuts. Look at Binary Ninja docs for inspiration. Each improvement should include screenshots and clear explanations. Begin with a specific section, e.g., 'Compilation' or 'Widgets', and create a pull request updating the relevant markdown files in the repository's docs folder.