Company
Date Published
Author
Michael King
Word count
919
Language
English
Hacker News points
None

Summary

I teamed up with Soma Osvay, a Full Stack Engineer at Starschema, to develop a project that addresses the need for efficient searching and filtering of internal developer documentation. The goal is to enable team members to quickly find and access relevant projects based on attributes such as technology used, programming language, and tags. To achieve this, we utilized NodeJS CLI and Algolia's search capabilities, which allowed us to split large markdown files into smaller records while maintaining deduplication of results. The tool also includes features like automatic splitting of READMEs over 50k characters, filtering out missing repositories, and conversion of markdown content to HTML for easier rendering. Additionally, we integrated GitHub API to fetch metadata and README files, and implemented a user-friendly interface with widgets such as pagination and page size selector. The project showcases the flexibility of Algolia's InstantSearch.js library and its potential applications in different use cases.