Repo brief: freeCodeCamp/devdocs

Generated by RepoPilot · document generated 2026-09-15 · concise human review Evidence snapshot · analyzed 2026-09-15T01:21:00.787Z · commit 0f9111bcde14

Verdict

Mixed — Single-maintainer risk — review before adopting

• Last commit 1d ago
• 4 active contributors
• MPL-2.0 licensed
• CI configured
• 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against OpenSSF Scorecard

What it is

DevDocs is a web-based API documentation browser that aggregates multiple developer API references into a single searchable interface. It combines a Ruby-based scraper (that generates documentation and metadata) with a Sinatra-backed JavaScript app, offering features like instant search, offline support via Service Workers, dark theme, and keyboard shortcuts. Monolithic structure: lib/app.rb and lib/docs.rb are core application entry points; lib/tasks/*.thor provides build/scrape/test commands via Thor task runner. Frontend lives in assets/javascripts/ (MVC pattern: app/, collections/, models/, templates/). Asset compilation is handled separately; no visible Node.js build…

Start here

Open these first:

• lib/app.rb — Primary Ruby application entry point; orchestrates the server, asset pipeline, and documentation system initialization.
• assets/javascripts/app/app.js — Core JavaScript application bootstrap; initializes routing, storage, and view layers for the single-page app.
• assets/javascripts/app/router.js — Client-side router managing navigation between documentation pages and views without full page reloads.
• lib/docs.rb — Documentation scraping and indexing engine; transforms API docs into searchable database entries.
• assets/javascripts/app/db.js — Client-side IndexedDB wrapper providing offline access to cached documentation data.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
gem install bundler
bundle install
bundle exec thor docs:download --default
bundle exec rackup

Then navigate to http://localhost:9292. Alternatively, use Docker: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

Daily commands:

bundle exec rackup starts the Rack server (default port 9292, as shown in README). Assets compile on first request. No visible npm or build script in file list.

Key cautions & unknowns

• Small team — 4 contributors active in recent commits
• Single-maintainer risk — top contributor 97% of recent commits
• Scorecard: default branch unprotected (0/10)
• Ruby version is strictly pinned to 4.0.6 (likely via .ruby-version file not in top 60). libcurl system dependency required but not managed by bundler—must be installed separately per platform. JavaScript runtime…
• Published-advisory coverage was unavailable for the captured dependencies.
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests
• OpenSSF Scorecard

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.