What you can contribute
Documentation
Improve or expand pages in the
docs/ directory — corrections, missing coverage, better examples, or entirely new guides.MCP server
Enhance the exploration MCP server in
mcp-server/ — new tools, better search, performance improvements, or bug fixes.Analysis
Write-ups, architecture diagrams, or annotated walkthroughs of specific subsystems.
Tooling
Scripts or tools that aid in studying the source code.
Setup
Prerequisites
- Node.js 18 or later
- Git
Clone the repo
MCP server development
The MCP server inmcp-server/ is the primary piece of runnable code in this repo. It is a standalone Node.js package:
Linting and type checking
These commands run against the originalsrc/ to verify nothing is broken, but they also apply to any new TypeScript you write:
Code style
For any new code inmcp-server/, tooling scripts, or other additions:
- TypeScript with strict mode enabled
- ES modules (
import/export, notrequire) - 2-space indentation (tabs are used in
src/to match the Biome config — don’t copy that convention into new files) - Descriptive variable names, minimal inline comments
Submitting changes
Questions
Open an issue on GitHub or reach out to nichxbt on X.See also
Exploring the source
Study paths, grep patterns, and key files for navigating the codebase.
MCP server
Connect any MCP-compatible client to explore the source interactively.