cake-build / cake-build/website

Add API to search index

Open
#1,100 3 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted up-for-grabs
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

API part is currently not indexed.

I currently don't see a way to index them properly with the way how API pages are structured (multiple headings as H1, title containing not only name but also type). When migrating to Statiq we should make sure that API docs can be indexed.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing how API pages are structured and how the current search index handles documentation. Revisit the indexing approach during the migration to Statiq, especially pages with multiple H1 headings and titles containing both a name and type. Done means API documentation pages can be indexed and searched correctly.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.