What DeployLog is
DeployLog is a "Changelog & release-notes platform for developers and small teams." A changelog is the dated list of what shipped, and an entry is one item on that list. "Write entries in Markdown; publish to a hosted page, an embeddable widget, and from the CLI, with AI-assisted release notes."
The name misleads. DeployLog does not deploy code, and it does not collect deployment logs. It is a "release-notes platform for developers and small teams."
How entries get in and where they show up
Entries do not have to be typed into a web form. Write one in the dashboard, the signed-in web app where each project lives. Or use the CLI, the command-line tool, which can "push entries from the terminal." Or install the GitHub Action, which "files an entry from each GitHub Release."
What readers get is on the same line as the writing: a hosted page and an embeddable widget. The hosted page is a public changelog served by DeployLog. The widget drops the same changelog into your own app or site, so readers never have to leave it. Both surfaces publish from one entry.
What this manual covers
This manual, the reference for using DeployLog, is split into chapters, each chapter a numbered section on one topic. DeployLog also drafts a manual for your own product from its repository, and checks it against the code; chapter 10 covers that. This manual was made the same way.
| No. | Title |
|---|---|
| 01 | Getting Started |
| 02 | Entries |
| 03 | Your public page |
| 04 | The widget |
| 05 | The CLI |
| 06 | GitHub |
| 07 | AI summaries |
| 08 | Subscribers |
| 09 | Analytics |
| 10 | The Manual |
| 11 | Organization |
| 12 | Plans and billing |
| 13 | Reference |
Where to start
Start at chapter 01. It takes a new account from sign-up to a first published entry, and every other chapter assumes you have done it.