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

@eimexdeveimexdev commented May 22, 2026•
edited by coderabbitai Bot
Loading

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

coderabbitaiBot commented May 22, 2026•
edited
Loading

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[bot]
chatgpt-codex-connectorBot reviewed May 22, 2026
View reviewed changes

@chatgpt-codex-connectorchatgpt-codex-connectorBot 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 threaddocs/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.

@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.

@eimexdeveimexdev changed the title Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed the codex/release-docs-install-guide branch from 7fa1795 to 8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev merged commit 2760eaa into mainMay 22, 2026
3 checks passed
@eimexdev
eimexdev deleted the codex/release-docs-install-guide branch May 22, 2026 02:53
@eimexdeveimexdev mentioned this pull request May 22, 2026
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

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
@eimexdeveimexdev
commented
May 22, 2026•

edited by coderabbitai
Bot
Loading

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
coderabbitaiBot
commented
May 22, 2026•

edited

Loading

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[bot]
chatgpt-codex-connectorBot
reviewed
May 22, 2026
View reviewed changes
@chatgpt-codex-connectorchatgpt-codex-connectorBot
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 threaddocs/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.
@chatgpt-codex-connectorchatgpt-codex-connectorBotMay 22, 2026

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 👍 / 👎.
@eimexdeveimexdev
changed the title
Add release install docs and checklistAdd release install docs and Ko-fi checklistMay 22, 2026
@eimexdev
eimexdevforce-pushed
the
codex/release-docs-install-guide
branch
from
7fa1795 to
8e3acadCompareMay 22, 2026 02:12
@eimexdev
eimexdev
merged commit 2760eaa
into
mainMay 22, 2026

3 checks passed

@eimexdev
eimexdev
deleted the

codex/release-docs-install-guide

branch
May 22, 2026 02:53
@eimexdeveimexdev
mentioned this pull request
May 22, 2026

Open

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

Reviewers

@chatgpt-codex-connectorchatgpt-codex-connector[bot]chatgpt-codex-connector[bot] left review comments

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@eimexdev