Vector35 / Vector35/binaryninja-api
Improve user docs for transform API and related UX
Open
Nobody has claimed this yet.
Effort: Trivial
Impact: Low
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100