Improve user docs for transform API and related UX

Offen
#7,968 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

Start by locating the user documentation for the transform system, then identify the transform API, container-related transform documentation, and example transforms in the API repository. Done means the user docs explain the copy-as, paste-from, and transform menus and link to all three relevant documentation or example areas.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Effort: Trivial Impact: Low

The transform system is not currently documented in the user docs.

We should:

  • highlight the copy as/paste from/transform menus
  • link to the appropriate transform API
  • link to the appropriate container-related transform documentation
  • link to any of the example transforms in the api repo
Vorherrschende Sprache
C++
Sterne
1.3k
Forks
298
Ø Merge
5 T. 5 Std.
Gemergte PRs (30 T.)
19

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Vector35/binaryninja-api

Alle Issues in Vector35/binaryninja-api

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.