Overview

Log4brains is a docs-as-code knowledge base for development and infrastructure projects. It allows for logging Architecture Decision Records (ADR) from your IDE and automatically publishing them as a static website. By logging decisions chronologically, Log4brains helps users understand past technical decisions, make new decisions confidently, and have up-to-date technical documentation and training materials. It also supports collaborative decision-making through pull requests.

Features

Docs-as-code: ADRs are written in markdown and stored in your git repository
Local preview with Hot Reload
Interactive ADR creation from the CLI
Static site generation for publishing to GitHub/GitLab Pages or S3
Timeline menu
Searchable ADRs
ADR metadata automatically inferred from raw text and git logs
Customizable template
Support for multi-package projects
Upcoming features include local images and diagrams support, RSS feed for new ADR notifications, decision backlog, @adr annotation for code references, and ADR creation/editing from the UI

Summary

Log4brains is a powerful tool for managing Architecture Decision Records (ADR) in development and infrastructure projects. It provides a user-friendly interface, allowing users to log decisions from their IDE and publish them as a static website. With features like local preview, interactive creation, and customizable templates, Log4brains helps teams document and understand their technical decisions. Additionally, upcoming features like local images support, RSS feed for notifications, and ADR creation from the UI further enhance its functionality. Whether it's understanding past decisions, onboarding new developers, or fostering a collaborative decision-making process, Log4brains is a valuable resource for any project.

Thomvaill

Log4brains

Tads Boilerplate