Vector35 / Vector35/binaryninja-api
documentation missing for memory versioning
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
The concept of memory versioning isn't documented anywhere. It probably should be explained in https://docs.binary.ninja/dev/bnil-overview.html#summary but that document should be re-visited to see if it belongs in the general user guide and not the developer docs as it might be too hard to find there? Or we need to split out concepts that users would find important (like reading IL) and concepts that are important for people building automation/plugins.
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 revisiting the summary in docs.binary.ninja/dev/bnil-overview.html and determine whether memory versioning belongs in the developer documentation or the general user guide. Define how user-facing concepts such as reading IL should be separated from concepts for automation and plugin authors, then document memory versioning in the appropriate location.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, reverse-engineering
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100