handsontable / handsontable/hyperformula
Docs: Exclude file `api-ref-readme.html` from search results (previously: `api-template.html`)
Open
Nobody has claimed this yet.
Bug
Docs
Impact: Medium
- Dominant language
- TypeScript
- Stars
- 2.8k
- Forks
- 171
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 7
Description
Description
This file shouldn't be in the search results. It is, in fact, duplicated, because it is displayed as HyperFormula API reference in the API reference section of the search results.
Links
https://handsoncode.slack.com/archives/C031GBX62SE/p1677854972076179 (internal)
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
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 api-ref-readme.html and the search-results configuration or generation entry point that includes it. Confirm why the file appears as “HyperFormula API reference,” then exclude that file and verify that the duplicate no longer appears in the API reference search results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100