How freecodecamp/devdocs works
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: scraper.rb Scraper engine · app.js Client application · app.rb Sinatra app · router.js Navigation and pages
Components 16
Documentation generation
- Scraper engine
lib/docs/core/scraper.rb - URL scraper
lib/docs/core/scrapers/url_scraper.rb - File scraper
lib/docs/core/scrapers/file_scraper.rb - Scraper filters
lib/docs/filters - Documentation catalog
lib/docs.rb - Documentation manifest
lib/docs/core/manifest.rb
Application serving
- Sinatra app
lib/app.rb
Browser experience
- Client application
assets/javascripts/app/app.js - Navigation and pages
assets/javascripts/app/router.js - Instant search
assets/javascripts/app/searcher.js - Document rendering
assets/javascripts/views/content/content.js - Offline support
assets/javascripts/app/serviceworker.js - Settings and shortcuts
assets/javascripts/app/settings.js
Client and output storage
- Generated documentation
- Browser cache
assets/javascripts/app/db.js
Other components
- Documentation reader
Connections 16
- Documentation reader → Sinatra app: opens
README.md - Sinatra app → Documentation reader: serves app
README.md - URL scraper → Scraper engine: scrapes URLs
README.md - File scraper → Scraper engine: scrapes files
README.md - Scraper engine → Scraper filters: applies filters
README.md - Scraper engine → Generated documentation: generates pages
README.md - Scraper engine → Documentation manifest: generates manifest
README.md - Documentation catalog → Scraper engine: defines docs
README.md - Generated documentation → Sinatra app: provides docs
README.md - Sinatra app → Client application: serves client
README.md - Client application → Navigation and pages: routes views
README.md - Client application → Instant search: supports search
README.md - Navigation and pages → Document rendering: loads pages
- Client application → Offline support: enables offline
README.md - Client application → Browser cache: caches data
README.md - Documentation reader → Settings and shortcuts: uses controls
README.md