parse-community / parse-community/docs

🐛 Search not working in API Reference

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

Nobody has claimed this yet.

type:bug
Dominant language
SCSS
Stars
317
Forks
507
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
Searching with browser in API References, only the content window (right pane) is searched. The index window where all the commands are listed (left pane) is not searched.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://parse-community.github.io/Parse-SDK-JS/api/
  2. Search in browser for a command in the left window
  3. Search returns no results

Expected behavior
Search should include the left command index window.

Desktop (please complete the following information):

  • OS: macOs
  • Browser Safari Version 13.0.4 (15608.4.9.1.3)

Additional context

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.

Research direction

Start at the API reference entry point https://parse-community.github.io/Parse-SDK-JS/api/ and reproduce the browser search issue, especially in Safari. Trace how the left command index and right content pane are generated, then verify that browser search can find commands listed in the left pane as well as content in the right pane.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, jekyll, scss
Domain
documentation, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.