nandorojo / solito

🧍‍♂️ React Native + Next.js, unified.
https://solito.dev
MIT License
3.35k stars 169 forks source link

Add Search Options to Docs #461

Open raghavyuva opened 5 months ago

raghavyuva commented 5 months ago

Is there an existing issue for this?

Do you want this issue prioritized?

Current Behavior

The current design of the documentation interface lacks a search bar, which forces users to navigate exclusively through a sidebar. This setup can be inconvenient and time-consuming, as users have to manually sift through various sections to find specific information. Incorporating a search bar would greatly enhance user experience by providing a quick and efficient way to locate topics or details within the documentation

Expected Behavior

The expected behavior of adding a search bar to the documentation interface should include the following features and functionalities:

Quick Access to Information: Users should be able to enter keywords or phrases into the search bar and receive relevant results from the documentation. This feature would significantly reduce the time spent navigating through the sidebar.

Accurate and Relevant Results: The search function should be optimized to return the most relevant sections of the documentation based on the user's query. It should prioritize results based on their relevance and accuracy to the searched terms.

Search Suggestions and Autocomplete: As users type their query, the search bar could offer suggestions or autocomplete options based on common searches or related topics within the documentation. This assists in refining searches and discovering relevant topics.

Search History or Recently Viewed: The search feature could include a history of recent searches or recently viewed topics, allowing users to easily revisit previous queries or sections.

Filter Options: Advanced search options to filter results by categories, such as tutorials, API references, FAQs, etc., would enhance the user's ability to narrow down search results.

Steps To Reproduce

No response

Versions

- Solito:
- Next.js:
- Expo:
- React Native:

Screenshots

No response

Reproduction

No response

nandorojo commented 4 months ago

yeah would be useful

unaisshemim commented 2 months ago

can you assign this task to me