handsontable / handsontable/hyperformula

Searching by build-in function name

Open
#696 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Docs Verified
Dominant language
TypeScript
Stars
2.8k
Forks
171
Avg merge
1d 22h
Merged PRs (30d)
7

Description

Description

Currently, to get to the page with the description of the available function from the search engine level, user have to enter the category to which the function is assigned, not the function itself.

From the user's point of view, it would be easier to enter the selected function into the search engine and thus navigate through the documentation.

Example

The user wants to find a description of the SUM function. It impossible through search engine right now.
Users need to find math built-in functions.
After entering page with build-in function users needs to use CMD + F

math
sum

Links

https://handsontable.github.io/hyperformula/guide/built-in-functions.html#list-of-available-functions

Type of issue
  • Missing documentation
  • Error in the documentation
  • Request for a demo
  • Request for a tutorial, guide etc.
  • Other issues, suggestions or ideas

Contributor guide

Open the contributing guide

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.

Research direction

Start with the linked built-in-functions guide and determine how its function names are exposed to the documentation search index. Verify the result by searching for SUM directly and confirming that the relevant function documentation page is returned.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.