Skip to content

Sleitnick/rbx-doc-search

Repository files navigation

img Roblox Creator Docs Search

This repository contains two parts:

  1. Data aggregation in relation to the Roblox Creator Docs
  2. Browser extension

Data Aggregation

Data aggregation is automated through a daily workflow, which creates a release of the aggregated data. This process is done through the Python scripts in the scripts directory.

This process helps ensure that the extension is using up-to-date metadata for search.

A new release is created for each aggregation collected. If no changes were found since the last release, the release is skipped.

Extension

Links:

The extension code can be found in the extension and src directories. The extension directory contains the core extension code. The search algorithm has been moved over to WASM to speed up the process, which can be found in the src directory.

WASM Compilation

To generate the WASM code, run the build.sh file. This will compile the code and output it within the relevant extension directory (extension/popup/pkg).

Package Extension

Run the package.sh file to package the extension file.