Better documentation for search in user guide

Open Beginner friendly
#8,190 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation, search

Research direction

Locate the UI user-guide section for search that currently links to the API documentation. Read the surrounding user-guide structure, then add UI-focused examples and explanation while retaining the API link; done means users can understand and use search from the UI documentation alone.

Written by the indexing model from the issue text.

Description

Right now the UI documentation for search just links to the API docs. We should improve the UI documentation with examples and explanation in addition to linking to the API docs.

Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Vector35/binaryninja-api

All issues in Vector35/binaryninja-api

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.