Skip to content

Add release install docs and Ko-fi checklist#7

Merged
eimexdev merged 13 commits into
mainfrom
codex/release-docs-install-guide
May 22, 2026
Merged

Add release install docs and Ko-fi checklist#7
eimexdev merged 13 commits into
mainfrom
codex/release-docs-install-guide

Conversation

@eimexdev

@eimexdev eimexdev commented May 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • Added a focused install guide, release checklist, changelog seed, and docs index updates for launch.
  • Kept the public README positioning simple: Free Beat for DaVinci Resolve. Open source for DaVinci Resolve.
  • Added release docs for the Ko-fi distribution flow and public-source launch gates.

Testing

  • python3 -m compileall openbeat scripts tests
  • Lua syntax loading for OpenBeatCommon.lua
  • uv run --no-project --python 3.11 --with-editable . python -m unittest discover -s tests -v
  • GitHub Actions macOS and Windows installer build checks are passing on this PR after the PR artifact-upload fix landed.

Summary by CodeRabbit

  • Documentation
    • Published CHANGELOG documenting v0.0.2 and v0.0.1 releases with known limitations and reliability guidance
    • Added installation guide with step-by-step macOS and Windows setup instructions
    • Expanded documentation index with new guides for installation, development, and release processes
    • Updated troubleshooting documentation with OS-specific log location information

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: ee715877-2111-44e5-80e9-24fe402bdfd9

📥 Commits

Reviewing files that changed from the base of the PR and between aa65155 and 8574d32.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.md
  • docs/README.md
  • docs/guide.md
  • docs/install.md
  • docs/release-checklist.md
✅ Files skipped from review due to trivial changes (4)
  • docs/guide.md
  • CHANGELOG.md
  • docs/install.md
  • docs/README.md

📝 Walkthrough

Walkthrough

This PR establishes OpenBeat's documentation infrastructure by adding release notes, an installation guide, and release operations procedures. It updates the main README and documentation index to point users to new guides, and enhances existing documentation with OS-specific information for better clarity.

Changes

Documentation and Release Infrastructure

Layer / File(s) Summary
Release history and documentation discovery
CHANGELOG.md, README.md, docs/README.md
Introduces CHANGELOG.md with v0.0.2 and v0.0.1 release history including features and known limits. Updates README installer section and docs section to link to new documentation. Refreshes docs/README.md index to include Install guide, User guide, Development notes, and Release checklist entries.
Installation guide
docs/install.md
New comprehensive guide covering download, macOS and Windows installation steps, update/uninstall procedures, verification workflow, and current Resolve compatibility notes.
User guide OS-specific paths
docs/guide.md
Reorganizes "Where to look for logs" section with separate macOS and Windows subsections for runtime log and analysis cache paths.
Release operations checklist
docs/release-checklist.md
New document for maintainers defining the pre-release workflow: version selection, local verification, installer builds, cross-platform smoke testing, GitHub Actions publishing, and post-launch site updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 Release notes and guides now bloom,
New docs light up the installation room,
With checklists for maintainers so keen,
OpenBeat's story is now fully seen! 📚✨


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: aa65155ac7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/install.md
## Windows

1. Run `OpenBeat-windows-<version>-installer.exe`.
2. Accept the default Resolve Fusion support folder unless you have moved Resolve's scripting support files.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Correct Windows install step for fixed destination path

Step 2 says users can "accept the default" support folder unless they moved it, but the current Windows installer does not offer any destination selection and always installs to default_resolve_root() (see scripts/build_installers.py in ready_step and start_install). For users whose Resolve scripting support files are not in %APPDATA%, this instruction is actionable but impossible to follow, and they may end up with a non-working install in the wrong directory.

Useful? React with 👍 / 👎.

@eimexdev eimexdev changed the title Add release install docs and checklist Add release install docs and Ko-fi checklist May 22, 2026
@eimexdev
eimexdev force-pushed the codex/release-docs-install-guide branch from 7fa1795 to 8e3acad Compare May 22, 2026 02:12
@eimexdev
eimexdev merged commit 2760eaa into main May 22, 2026
3 checks passed
@eimexdev
eimexdev deleted the codex/release-docs-install-guide branch May 22, 2026 02:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant