openmcp-project / openmcp-project/docs
Add search bar to documentation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 1
- Forks
- 7
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 10
Description
What would you like to be added?
A search bar in the documentation site so that developers and operators can quickly
find specific configuration options, API references, or conceptual explanations.
As a developer reading the docs, I want a search bar so that I can type a keyword
or phrase and immediately jump to the relevant page or section, without needing to
know the doc structure upfront.
Docusaurus supports several search integrations — see the official docs for options:
https://docusaurus.io/docs/search#using-typesense-docsearch
Why is this needed?
There is no search functionality in the documentation site. Currently users must
manually scroll through the sidebar or browse page by page. I'm always frustrated
when I know a concept or term is documented somewhere but can't locate it quickly —
I have to guess which section it lives in and click through multiple pages.
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 with the Docusaurus search documentation linked in the issue and inspect the documentation site's existing configuration and navigation entry points. Choose a supported search integration, then verify that developers and operators can search configuration options, API references, and conceptual explanations and reach the relevant page or section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100