Website documentation needs search functionality

Open
#263 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
html
Domain
documentation, search, web-dev

Research direction

Review the website's current static-site setup and the linked Algolia/Jekyll approach first. Define the documentation scope to index and verify that visitors can search Containers.dev reference information; the issue names no files or tests, so the implementation entry points must be located.

Written by the indexing model from the issue text.

Description

enhancement

Currently as of 07-26-2023, there is no ability to search the Containers.dev website for specific reference information.

This would be a well used feature that would help better adoption of the devcontainer spec.

Seems like this is possible via Algolia.

https://dev.to/adrienjoly/make-your-static-site-searchable-with-jekyll-algolia-edh

Dominant language
HTML
Stars
207
Forks
435
Avg merge
2d 7h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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.

More from devcontainers/devcontainers.github.io

All issues in devcontainers/devcontainers.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.