Welcome to the Small Dev Talk documentation. This directory contains guides for understanding, maintaining, and extending the Small Dev Talk codebase.
Small Dev Talk is a static client-side site. On page load, the browser script fetches legacy page definitions and article metadata, then renders either a listing view or a single article based on the URL query string.
The project is currently in maintenance mode, meaning focus is on bug fixes and security updates rather than new features.
Understand the system design, data flows, and core components that power Small Dev Talk.
- System Architecture — Overview of modules, components, and interactions
- Data Flow — How articles flow through the application
- Dependencies & Integrations — External services and libraries
Practical guides for developers working with the codebase.
- Developer Setup & Getting Started — Installation, configuration, and local development
- Adding & Publishing Articles — How to add new articles and manage article metadata
- Testing & Validation — Running tests, linting, and validation scripts
- Deployment & Build Process — Building, testing, and deploying to production
Detailed documentation for key modules and functions.
- ArticleFiller Class — Core class for article loading and page rendering
- Sentry Integration — Error tracking configuration
- Service Worker — Precaching and runtime caching behavior
- Build Tools & Scripts — Tooling and npm scripts
| Technology | Purpose | Version |
|---|---|---|
| Bootstrap | UI framework (local bundle) | Local copy |
| jQuery | DOM utilities (local bundle) | Local copy |
| Showdown.js | Markdown to HTML conversion | Local copy |
| Sentry | Error tracking | v10.32.1 |
| Service Workers / Workbox | Precaching and caching | v7.4.0 |
| Jest | Unit testing | v30.2.0 |
| Cypress | E2E testing | v15.10.0 |
| ESLint | Code linting | v10.0.0 |
| Prettier | Code formatting | v3.8.1 |
- Repository: AlexJSully/Small-Dev-Talk
- Live Site: smalldevtalk.net
- Original Archive: Small Dev Talk on Tumblr
- Issue Tracker: GitHub Issues
- Project Status: Maintenance Mode
- Latest Version: 1.3.4
- License: GPL-3.0
- Automation: Code quality and CodeQL workflows run in GitHub Actions
To contribute, see CONTRIBUTING.md at the repository root.