Skip to content

Enhance KB: Document maxUsers cap and performance trade-offs in DevIndex #9226

@tobiu

Description

@tobiu

Following the implementation of the maxUsers cap (50k limit) for the DevIndex, we need to apply the Knowledge Base Enhancement Strategy to document this architectural decision.

Rationale: If we allowed the index to grow unbounded (e.g., 100k users), the users.jsonl file would reach ~40MB. While we stream and gzip the data, client-side memory constraints and parsing overhead would eventually degrade the application's responsiveness and UX. The cap ensures the app remains fast and "fun to use" while maintaining high quality via the dynamic contribution threshold.

Tasks:

  1. Update Storage.mjs: Enhance the class-level JSDoc to explain the pruning mechanism and the performance trade-off rationale behind the users.jsonl file size.
  2. Update config.mjs: Add detailed context to the maxUsers property explaining why the 50,000 limit exists (40MB file size, client-side performance).
  3. Update Updater.mjs: Briefly mention the dynamic threshold interaction with the maxUsers cap in the workflow description.

Metadata

Metadata

Assignees

Labels

aidocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions