# freecodecamp/devdocs architecture

> Architecture diagram of the GitHub repository freecodecamp/devdocs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/freecodecamp/devdocs
- Repository: https://github.com/freecodecamp/devdocs

## Overview

DevDocs turns third-party reference material into normalized, indexed documentation, then serves it through a browser-based documentation and search interface. The principal workflow is documentation scraping and filtering, generation of page/index/offline data and a manifest, then browser loading, navigation, and search. The README documents the main capabilities, including offline support, keyboard navigation, mobile UI, and theme support; source excerpts are limited, so edges describe only documented or excerpt-visible relationships.

Main entry points: [`lib/docs/core/scraper.rb`](https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scraper.rb) (Scraper engine), [`assets/javascripts/app/app.js`](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/app.js) (Client application), [`lib/app.rb`](https://github.com/freecodecamp/devdocs/blob/main/lib/app.rb) (Sinatra app), [`assets/javascripts/app/router.js`](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/router.js) (Navigation and pages)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_generation["Documentation generation"]
  node_scraper["Scraper engine<br/>[scraper.rb]"]
  node_url_scraper["URL scraper<br/>[url_scraper.rb]"]
  node_file_scraper["File scraper<br/>[file_scraper.rb]"]
  node_filters["Scraper filters"]
  node_doc_catalog["Documentation catalog<br/>[docs.rb]"]
  node_manifest["Documentation manifest<br/>[manifest.rb]"]
end

subgraph group_serving["Application serving"]
  node_web_app["Sinatra app<br/>[app.rb]"]
end

subgraph group_browser["Browser experience"]
  node_browser_app["Client application<br/>[app.js]"]
  node_navigation["Navigation and pages<br/>[router.js]"]
  node_search["Instant search<br/>[searcher.js]"]
  node_doc_rendering["Document rendering<br/>[content.js]"]
  node_offline["Offline support<br/>[serviceworker.js]"]
  node_interface["Settings and shortcuts<br/>[settings.js]"]
end

subgraph group_persistence["Client and output storage"]
  node_artifact_store[("Generated documentation")]
  node_client_data[("Browser cache<br/>[db.js]")]
end

node_reader(("Documentation reader"))

node_reader -->|"opens"| node_web_app
node_web_app -->|"serves app"| node_reader
node_url_scraper -->|"scrapes URLs"| node_scraper
node_file_scraper -->|"scrapes files"| node_scraper
node_scraper -->|"applies filters"| node_filters
node_scraper -->|"generates pages"| node_artifact_store
node_scraper -->|"generates manifest"| node_manifest
node_doc_catalog -->|"defines docs"| node_scraper
node_artifact_store -->|"provides docs"| node_web_app
node_web_app -->|"serves client"| node_browser_app
node_browser_app -->|"routes views"| node_navigation
node_browser_app -->|"supports search"| node_search
node_navigation -.->|"loads pages"| node_doc_rendering
node_browser_app -->|"enables offline"| node_offline
node_browser_app -->|"caches data"| node_client_data
node_reader -->|"uses controls"| node_interface

click node_web_app "https://github.com/freecodecamp/devdocs/blob/main/lib/app.rb"
click node_scraper "https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scraper.rb"
click node_url_scraper "https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scrapers/url_scraper.rb"
click node_file_scraper "https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scrapers/file_scraper.rb"
click node_filters "https://github.com/freecodecamp/devdocs/tree/main/lib/docs/filters"
click node_doc_catalog "https://github.com/freecodecamp/devdocs/blob/main/lib/docs.rb"
click node_manifest "https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/manifest.rb"
click node_browser_app "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/app.js"
click node_navigation "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/router.js"
click node_search "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/searcher.js"
click node_doc_rendering "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/views/content/content.js"
click node_offline "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/serviceworker.js"
click node_client_data "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/db.js"
click node_interface "https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/settings.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_scraper,node_url_scraper,node_file_scraper,node_filters,node_doc_catalog,node_manifest toneBlue
class node_web_app toneAmber
class node_browser_app,node_navigation,node_search,node_doc_rendering,node_offline,node_interface toneMint
class node_artifact_store,node_client_data toneRose
class node_reader toneIndigo
```

## Components

### Documentation generation

- [Scraper engine](https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scraper.rb): `lib/docs/core/scraper.rb`
- [URL scraper](https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scrapers/url_scraper.rb): `lib/docs/core/scrapers/url_scraper.rb`
- [File scraper](https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/scrapers/file_scraper.rb): `lib/docs/core/scrapers/file_scraper.rb`
- [Scraper filters](https://github.com/freecodecamp/devdocs/tree/main/lib/docs/filters): `lib/docs/filters`
- [Documentation catalog](https://github.com/freecodecamp/devdocs/blob/main/lib/docs.rb): `lib/docs.rb`
- [Documentation manifest](https://github.com/freecodecamp/devdocs/blob/main/lib/docs/core/manifest.rb): `lib/docs/core/manifest.rb`

### Application serving

- [Sinatra app](https://github.com/freecodecamp/devdocs/blob/main/lib/app.rb): `lib/app.rb`

### Browser experience

- [Client application](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/app.js): `assets/javascripts/app/app.js`
- [Navigation and pages](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/router.js): `assets/javascripts/app/router.js`
- [Instant search](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/searcher.js): `assets/javascripts/app/searcher.js`
- [Document rendering](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/views/content/content.js): `assets/javascripts/views/content/content.js`
- [Offline support](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/serviceworker.js): `assets/javascripts/app/serviceworker.js`
- [Settings and shortcuts](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/settings.js): `assets/javascripts/app/settings.js`

### Client and output storage

- **Generated documentation**
- [Browser cache](https://github.com/freecodecamp/devdocs/blob/main/assets/javascripts/app/db.js): `assets/javascripts/app/db.js`

### Other components

- **Documentation reader**

## Connections

- Documentation reader → Sinatra app: opens (evidence: `README.md`)
- Sinatra app → Documentation reader: serves app (evidence: `README.md`)
- URL scraper → Scraper engine: scrapes URLs (evidence: `README.md`)
- File scraper → Scraper engine: scrapes files (evidence: `README.md`)
- Scraper engine → Scraper filters: applies filters (evidence: `README.md`)
- Scraper engine → Generated documentation: generates pages (evidence: `README.md`)
- Scraper engine → Documentation manifest: generates manifest (evidence: `README.md`)
- Documentation catalog → Scraper engine: defines docs (evidence: `README.md`)
- Generated documentation → Sinatra app: provides docs (evidence: `README.md`)
- Sinatra app → Client application: serves client (evidence: `README.md`)
- Client application → Navigation and pages: routes views (evidence: `README.md`)
- Client application → Instant search: supports search (evidence: `README.md`)
- Navigation and pages → Document rendering: loads pages
- Client application → Offline support: enables offline (evidence: `README.md`)
- Client application → Browser cache: caches data (evidence: `README.md`)
- Documentation reader → Settings and shortcuts: uses controls (evidence: `README.md`)
