Part of a portfolio. See more at ahmed.hmeid.uk
Phase 4

Documentation

AI-generated documentation that stays in sync with what was actually built. User docs, release notes, and technical documentation — all created automatically from the cycle's context.

Purpose

The documentation phase is an optional stage between review and cycle completion. When enabled, the AI generates three types of documentation based on what was actually built, reviewed, and accepted in the cycle — not from aspirational specs, but from real implementation outcomes.

Generated docs are fully editable in a rich-text editor before the cycle completes. They can be included as links in the GitHub PR or uploaded as public PDFs.

Why We Built This

Documentation is the first thing to be cut when teams are under pressure, yet it is critical for onboarding, support, and compliance. By generating it automatically from actual build outcomes, Bynary ensures documentation exists without adding to anyone's workload.

  • •Always accurate — Generated from what was actually built, not what was planned
  • •Three perspectives — End-user docs, stakeholder release notes, developer technical docs
  • •Editable before shipping — Full WYSIWYG editor for refinement
User Docs
Release Notes
Technical Docs
User Authentication Guide
This release adds email/password authentication with invitation-based signup. New users receive an invitation email with a secure token...
AI-generated, editable
Auto-saved
Skip Docs
Complete Cycle

The documentation editor with tabs for each doc type and auto-generated content.

How Documentation Works
1

Configure Per-Project

In your project settings, configure each document type as: Mandatory (must have content before cycle completion), Optional (generated by default, can be skipped), or Never (not generated; if all types are 'never', the docs phase is skipped entirely).
2

Automatic Generation

When the cycle enters the documentation phase, the AI generates content for each enabled document type. It uses the full cycle context — features, tasks, build outcomes, review results, and code changes.
3

Edit and Refine

Generated docs open in a rich-text WYSIWYG editor (Plate). You can edit the content freely — fix wording, add context, remove sections, or rewrite entirely. Changes are auto-saved.
4

Regenerate if Needed

If you want a fresh version, click the regenerate button for any individual doc type. This clears the current content and triggers a new AI generation pass.
5

Complete or Skip

When satisfied, complete the cycle to create the GitHub PR with doc links included. Or skip docs if no mandatory types require content.
Document Types

Three document types, each independently configurable per project:

User DocumentationEnd users

End-user facing documentation describing new features, how to use them, and done whens outcomes.

Release NotesStakeholders

Stakeholder-facing changelog categorizing changes, summarizing review outcomes, and including build statistics.

Technical DocumentationDevelopers

Developer-facing documentation covering architecture impact, file changes, implementation details, and technical decisions.

Configuration Options

Documentation behavior is configured per-project in project settings:

Doc Type Settings

Each of the three doc types can be independently set to mandatory, optional, or never.

Link Visibility

Choose between private links (require app login) or public links (docs uploaded as PDFs to Supabase Storage with unguessable URLs).

Frequently Asked Questions

Is the documentation phase required?

No. If all three document types are set to 'never' in project settings, the cycle skips the documentation phase entirely and goes directly from review to completed.

Can I edit the generated docs?

Yes. The documentation opens in a full WYSIWYG markdown editor. You can edit freely, and changes auto-save. You can also regenerate any document type for a fresh AI-generated version.

Can two people edit the same document?

Not at the same time. A lock stops two people editing the same document type at once, and admins can release a stale lock.

How are docs included in the PR?

When completing the cycle, the GitHub PR body includes a Documentation section with links to each generated document. The link format depends on your 'doc link visibility' setting.

What model generates the documentation?

Bynary selects the Claude model automatically, using adaptive thinking for higher quality output.

Current Considerations

We've thought carefully about these areas. Some are intentional design choices, others are on our roadmap.

Markdown-only format

Documentation is generated and stored as markdown. The WYSIWYG editor provides a visual editing experience, but the underlying format is markdown.

No version history

Edits to generated docs overwrite the previous version. There is no built-in version history. The original AI-generated version can be recovered by using the regenerate feature.

PDF rendering is basic

When using public link mode, docs are converted to PDF using pdfkit. The PDF rendering covers common markdown elements but may not perfectly render complex tables or nested structures.