UTDNebula / website

General documentation for Project Nebula, an initiative to build tools that help students.
https://www.utdnebula.com
MIT License
9 stars 11 forks source link

[Feature Request] Add search functionality to website #21

Open WillieCubed opened 2 years ago

WillieCubed commented 2 years ago

Overview

The Project Nebula website is meant to be an entry point for all important Project Nebula information, including references for brand guidelines and information on how contributors can get involved.

Ideally, a website visitor should be able to visit the website, type into a search bar, and get links to relevant information for maintainers or project documentation.

Proposal

Docusarus makes search easy. In short, we'll follow the framework's documentation, which includes information on how to set this up using Algolia, a search index provider. The best part? It's free for open-source projects, and we're definitely open source.

Whoever is assigned to this issue would likely have to work with @CharlieMahana or myself (but preferably the former ;)) to set up Algolia from the admin side.

Supplementary Information

Ideally, all pages and headings should be indexed. I'm pretty sure Algolia can support this.