MaibornWolff / MaibornWolff/codecharta

Improve Github pages search

Open
#4,016 0 comments 0 reactions 0 assignees View on GitHub
documentation feature
Dominant language
TypeScript
Stars
529
Forks
56
Avg merge
7h 17m
Merged PRs (30d)
34

Description

# Feature request

Improve the behaviour of the github pages search engine so that it presents more useful results.

## Description

As a visitor of the Github pages, I want a better search engine so that i can actually find what im looking for.

## Notes
We are currently using 'lunr' as a search engine but it does not seem to find the right things. For example searching for 'ccsh' does not show the 'CodeCharta Shell' page but searching for '(ccsh)' does. It also likes to show individual release notes on a search term. Maybe we should exclude these or add a toggle to search for them.
We could either use a different engine or try to improve the behaviour of the current one somehow.

## Acceptance criteria
-
-
-

## Assumptions & Exclusions

## Development notes (optional Task Breakdown)
- [ ]
- [ ]
- [ ]

## Open questions

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Start by locating the GitHub Pages search implementation and its Lunr integration, then clarify the expected result ranking, release-note handling, and acceptance criteria before choosing an implementation. Done should mean the agreed search examples return useful results and are covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
search, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.