rizinorg/cutter

Ideas for improving documentation

Open

#744 建立於 2018年10月1日

在 GitHub 查看
 (9 留言) (0 反應) (0 負責人)C++ (14,852 star) (1,123 fork)batch import
DocumentationEnhancementHacktoberFestgood first issue

描述

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

貢獻者指南

技術棧
cpp
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic understanding of CutterFamiliarity with markdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.