Skip to content

docs: add dotbot v4 framework overview document#584

Open
aselim31 wants to merge 1 commit into
mainfrom
docs/v4-framework-overview
Open

docs: add dotbot v4 framework overview document#584
aselim31 wants to merge 1 commit into
mainfrom
docs/v4-framework-overview

Conversation

@aselim31

@aselim31 aselim31 commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds docs/DOTBOT-V4-FRAMEWORK.md — a single authoritative reference for the dotbot v4 architecture, install model, and key concepts.

Why this is needed

With v4.0.0 shipped and the new shim-based model in place, contributors and operators need one place to understand:

  • What changed vs v3
  • How DOTBOT_HOME, bootstrap.ps1, and sparse dotbot init work
  • The layered content resolver and 4-layer settings chain
  • Key commands and their contracts
  • Migration path from v3

This information was previously scattered across README, AGENTS.md, CHANGELOG.md, and MIGRATING.md.

Contents

  • What changed in v4 (comparison table)
  • Install (bootstrap.ps1, package managers)
  • Core concepts (DOTBOT_HOME, .bot/, workflows, stacks, providers)
  • Key commands reference table
  • Architecture diagram
  • Settings chain (4 layers)
  • Workflow & stack model
  • Migration from v3 (short version + link to MIGRATING.md)

Related

Closes #581

Checklist

  • Links to MIGRATING.md and AGENTS.md
  • Architecture diagram included
  • Commands table complete
  • Reviewer sign-off

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

docs: add dotbot v4 framework overview document

1 participant