P2: Trust surface & docs for public launch readiness#18
Merged
Conversation
Prepare the repo storefront with README, privacy/security policies, self-hosting guide, community templates, and metadata fixes ahead of going public. Co-authored-by: Cursor <cursoragent@cursor.com>
Add install specs for RAM, storage, and permissions, and remove Intel Mac references from the public docs. Co-authored-by: Cursor <cursoragent@cursor.com>
GitHub renders Mermaid cleanly; the box-drawing version misaligned in the rendered README. Co-authored-by: Cursor <cursoragent@cursor.com>
Ship the hero GIF, feature screenshots, and a regenerate script so the public README storefront renders with cohesive mocked meeting content. Co-authored-by: Cursor <cursoragent@cursor.com>
…tions. Replace possessive "your Mac" phrasing with "your computer" outside macOS-specific requirements, sharpen the download CTA, fix the confusing paywall comparison row, and message Windows as coming soon. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the meetily-style stacked badge/nav rows with a single primary download CTA and a slim curated badge line. Re-sequence the hero GIF to open on the recording state and flow through transcript, notes, and Ask AI, dropping the detection scene that duplicated detection.png. Co-authored-by: Cursor <cursoragent@cursor.com>
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds documentation, community governance and GitHub templates, self-hosting configuration and package metadata updates, and a Playwright-based README media generation CLI with capture guidance. ChangesPublic Release & Self-Hosting Foundation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
.github/ISSUE_TEMPLATE/config.yml (1)
9-9: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueAdd trailing newline.
POSIX text files should end with a newline character. Add a blank line at the end of the file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/ISSUE_TEMPLATE/config.yml at line 9, Add a trailing newline to the end of the config.yml file so the file ends with a POSIX-compliant newline character; simply append a single blank line/newline at the end of .github/ISSUE_TEMPLATE/config.yml (ensure the file ends with '\n')..github/PULL_REQUEST_TEMPLATE.md (1)
29-29: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueAdd trailing newline.
POSIX text files should end with a newline character. Add a blank line at the end of the file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/PULL_REQUEST_TEMPLATE.md at line 29, The file .github/PULL_REQUEST_TEMPLATE.md is missing a trailing newline; update the file by adding a single blank line (newline character) at the end of the file so it conforms to POSIX text file conventions and ensures tools that expect an EOF newline behave correctly..github/ISSUE_TEMPLATE/feature.md (1)
25-25: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueAdd trailing newline.
POSIX text files should end with a newline character. Add a blank line at the end of the file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/ISSUE_TEMPLATE/feature.md at line 25, Add a POSIX-compliant trailing newline by appending a single blank line at the end of the file (ensure the file ends with a newline character at EOF); update the .github/ISSUE_TEMPLATE/feature.md file so its final character is a newline (i.e., add a trailing newline at EOF)..github/ISSUE_TEMPLATE/bug.md (1)
41-41: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueAdd trailing newline.
POSIX text files should end with a newline character. Add a blank line at the end of the file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/ISSUE_TEMPLATE/bug.md at line 41, Add a POSIX-compliant trailing newline to the end of the ISSUE TEMPLATE file (bug.md) by ensuring there is a blank line/linefeed character at the end of the file so the file ends with a newline character.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 47-51: Add a blank line before the opening fenced code block (the
line with ```) and a blank line after the closing fenced code block (the closing
```) in the CONTRIBUTING.md snippet so the fenced block is separated from
surrounding text per MD031; locate the triple-backtick block shown in the diff
and insert one empty line immediately above the first ``` and one empty line
immediately below the last ```.
In `@docs/assets/CAPTURE_CHECKLIST.md`:
- Around line 13-22: The fenced code block showing the directory tree (the
triple-backtick block containing the docs/assets/ tree and the screenshots list)
is missing a language specifier; update that and any other similar blocks (the
one around lines 28–40) by adding an appropriate language tag such as ```text or
```bash after the opening backticks so the snippets render/accessibly with
syntax highlighting and correct semantic labeling.
In `@docs/SELF_HOSTING.md`:
- Around line 55-57: Update the SELF_HOSTING.md OAuth callback paragraph to
explicitly describe the end-to-end flow: state that the user initiates OAuth in
the desktop app, the app opens the worker's URL in the browser, the worker
redirects the browser to the OAuth provider (Google/Microsoft), the provider
then redirects back to the worker with the authorization code, and finally the
worker exchanges the code for a token and redirects the browser to the desktop
app's localhost callback (http://127.0.0.1:42813) with the token; keep the
explanation brief and sequential so readers can follow each handoff.
In `@README.md`:
- Around line 99-100: The README currently cites Meetily and links to their
install docs in the system requirements paragraph ("Local-first meeting apps
need real hardware headroom... Meetily publishes similar guidance..."), which
creates an unusual competitor comparison; remove the Meetily citation and link
and rephrase the paragraph to a generic statement about hardware needs and
AutoDoc's own requirements (e.g., replace the two sentences with: "Local-first
meeting apps need real hardware headroom for on-device transcription and
summarization. AutoDoc's requirements below reflect our bundled models and full
feature set."). Ensure the original text fragment containing "Local-first
meeting apps need real hardware headroom..." is updated accordingly and no
external competitor links remain.
In `@scripts/generate-readme-media.js`:
- Around line 708-712: The Python snippet currently interpolates frameDir and
output directly; change makeGifWithPillow to write a JSON config (e.g.
gif-config.json at configPath) containing frameDir, output, and frameCount, then
invoke Python with a script that opens that JSON (use config = json.load(...))
and uses config["frameDir"], config["output"], and config["frameCount"] when
building frames and saving the GIF; ensure you stop interpolating
frameDir/output into the Python source and instead reference configPath (the
written JSON) so paths are passed safely.
- Around line 703-718: The makeGifWithPillow function spawns python3 to import
PIL but doesn't pre-check for Pillow, causing unclear failures; add a preflight
check by invoking python3 -c "import PIL" (via spawnSync) before running the GIF
snippet and if it fails throw a clear Error guiding the user to install Pillow
(e.g., "Pillow not found; pip install pillow" or equivalent), and also add a
short note about the Python+Pillow requirement to README.md or CONTRIBUTING.md
(or docs/) so contributors know the dependency; reference the function name
makeGifWithPillow and the existing spawnSync usage when making the change.
- Line 726: The page is created with deviceScaleFactor: 1 which conflicts with
the project's 2× capture guidance; update the generator to create the Playwright
page with deviceScaleFactor: 2 (change the browser.newPage call where
SCREENSHOT_VIEWPORT is used), then ensure any viewport sizes used for captures
are set as CSS pixels (i.e., pass widths/heights that are half the intended
raster pixel size via page.setViewportSize or by adjusting SCREENSHOT_VIEWPORT)
so the captures are rendered at 2× and can be downscaled to ~1280px for export;
alternatively, if you prefer not to change capture code, update
docs/assets/CAPTURE_CHECKLIST.md to reflect the current deviceScaleFactor: 1
behavior—pick one approach and make the corresponding change to either the
browser.newPage(...) deviceScaleFactor or the checklist.
---
Outside diff comments:
In @.github/ISSUE_TEMPLATE/bug.md:
- Line 41: Add a POSIX-compliant trailing newline to the end of the ISSUE
TEMPLATE file (bug.md) by ensuring there is a blank line/linefeed character at
the end of the file so the file ends with a newline character.
In @.github/ISSUE_TEMPLATE/config.yml:
- Line 9: Add a trailing newline to the end of the config.yml file so the file
ends with a POSIX-compliant newline character; simply append a single blank
line/newline at the end of .github/ISSUE_TEMPLATE/config.yml (ensure the file
ends with '\n').
In @.github/ISSUE_TEMPLATE/feature.md:
- Line 25: Add a POSIX-compliant trailing newline by appending a single blank
line at the end of the file (ensure the file ends with a newline character at
EOF); update the .github/ISSUE_TEMPLATE/feature.md file so its final character
is a newline (i.e., add a trailing newline at EOF).
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 29: The file .github/PULL_REQUEST_TEMPLATE.md is missing a trailing
newline; update the file by adding a single blank line (newline character) at
the end of the file so it conforms to POSIX text file conventions and ensures
tools that expect an EOF newline behave correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1ceda0cd-8423-43bd-8bc8-483004a3063a
⛔ Files ignored due to path filters (6)
docs/assets/demo.gifis excluded by!**/*.gifdocs/assets/logo.pngis excluded by!**/*.pngdocs/assets/screenshots/ask-ai.pngis excluded by!**/*.pngdocs/assets/screenshots/detection.pngis excluded by!**/*.pngdocs/assets/screenshots/notes.pngis excluded by!**/*.pngdocs/assets/screenshots/transcript.pngis excluded by!**/*.png
📒 Files selected for processing (33)
.env.example.github/ISSUE_TEMPLATE/bug.md.github/ISSUE_TEMPLATE/config.yml.github/ISSUE_TEMPLATE/feature.md.github/PULL_REQUEST_TEMPLATE.mdCHANGELOG.mdCODE_OF_CONDUCT.mdCONTRIBUTING.mdPRIVACY.mdREADME.mdSECURITY.mddocs/SELF_HOSTING.mddocs/assets/CAPTURE_CHECKLIST.mddocs/design/README.mddocs/design/plans/2026-03-24-calendar-integration.mddocs/design/plans/2026-03-24-core-shell-ui.mddocs/design/plans/2026-03-24-recording-engine.mddocs/design/plans/2026-03-24-transcription-pipeline.mddocs/design/plans/2026-03-25-encryption-at-rest.mddocs/design/plans/2026-03-25-speaker-diarization.mddocs/design/plans/2026-03-26-onboarding.mddocs/design/plans/2026-03-27-multi-calendar.mddocs/design/plans/2026-03-28-segment-video-jump.mddocs/design/specs/2026-03-24-autodoc-design.mddocs/design/specs/2026-03-24-transcription-pipeline-design.mddocs/design/specs/2026-03-25-encryption-at-rest-design.mddocs/design/specs/2026-03-25-speaker-diarization-design.mddocs/design/specs/2026-03-26-onboarding-design.mddocs/design/specs/2026-03-27-multi-calendar-design.mddocs/design/specs/2026-03-28-segment-video-jump-design.mdelectron-builder.ymlpackage.jsonscripts/generate-readme-media.js
Keep the full self-hosting variable block from P2, which already includes AUTODOC_AUTH_WORKER_URL added on main. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@package.json`:
- Line 78: The dependency "`@cloudflare/workers-types`": "^4.20260610.1" uses a
caret allowing floating upgrades to that day-based release; change it to a
pinned exact version (remove the ^ so it reads "`@cloudflare/workers-types`":
"4.20260610.1") or explicitly update the package.json to a stable pinned version
after reviewing the release notes, so builds don’t unexpectedly pick up same-day
patch changes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@package.json`:
- Line 78: The dependency "`@cloudflare/workers-types`": "^4.20260610.1" uses a
caret allowing floating upgrades to that day-based release; change it to a
pinned exact version (remove the ^ so it reads "`@cloudflare/workers-types`":
"4.20260610.1") or explicitly update the package.json to a stable pinned version
after reviewing the release notes, so builds don’t unexpectedly pick up same-day
patch changes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: e55e5c4e-c886-46e2-a2d8-3c91a9967cc3
📒 Files selected for processing (1)
package.json
🛑 Comments failed to post (1)
package.json (1)
78-78: 🧹 Nitpick | 🔵 Trivial
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash # Description: Verify `@cloudflare/workers-types` version exists on npm # Check available versions npm view `@cloudflare/workers-types` versions --json | jq -r '.[]' | grep "^4.20260610" # Check if the specific version exists npm view `@cloudflare/workers-types`@4.20260610.1 version 2>/dev/null || echo "Version 4.20260610.1 not found"Repository: DuetDisplay/AutoDoc-Local
Length of output: 95
@cloudflare/workers-types^4.20260610.1is available on npm.The
4.20260610.1release resolves on npm (so the same-day version format isn’t a “nonexistent version” risk). The remaining concern is stability/early-bug risk from depending on a newly published day; consider pinning to the exact version (or reviewing release notes) if you want to minimize churn.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@package.json` at line 78, The dependency "`@cloudflare/workers-types`": "^4.20260610.1" uses a caret allowing floating upgrades to that day-based release; change it to a pinned exact version (remove the ^ so it reads "`@cloudflare/workers-types`": "4.20260610.1") or explicitly update the package.json to a stable pinned version after reviewing the release notes, so builds don’t unexpectedly pick up same-day patch changes.
Expand the self-hosting OAuth walkthrough into an explicit end-to-end sequence verified against the worker routes, and remove the Meetily citation/links from the README system-requirements section in favor of generic local-first framing. Co-authored-by: Cursor <cursoragent@cursor.com>
Fail fast with an install hint when python3/Pillow is missing before building the hero GIF, and rewrite the capture checklist rationale notes to drop direct competitor references while keeping the positioning intent. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
scripts/generate-readme-media.js (2)
731-737:⚠️ Potential issue | 🟠 Major | ⚡ Quick winWrap server/browser setup in the same
try/finallythat performs cleanup.If
startRendererServer()orchromium.launch()throws before Line 747, the cleanup block never runs. That can leave the Vite server open and hang the script despite settingprocess.exitCodelater.Suggested fix
async function main() { fs.mkdirSync(SCREENSHOT_DIR, { recursive: true }) fs.mkdirSync(TMP_DIR, { recursive: true }) - - const { server, url } = await startRendererServer() - const browser = await chromium.launch() - const page = await browser.newPage({ viewport: SCREENSHOT_VIEWPORT, deviceScaleFactor: 1 }) - page.on('console', (message) => { + let server + let url + let browser + try { + ({ server, url } = await startRendererServer()) + browser = await chromium.launch() + const page = await browser.newPage({ viewport: SCREENSHOT_VIEWPORT, deviceScaleFactor: 1 }) + page.on('console', (message) => { if (message.type() === 'warning' || message.type() === 'error') { console.warn(`[browser ${message.type()}] ${message.text()}`) } - }) - page.on('pageerror', (error) => { - console.error('[browser pageerror]', error) - }) - - try { + }) + page.on('pageerror', (error) => { + console.error('[browser pageerror]', error) + }) + await captureContent(page, detectionHtml(), path.join(SCREENSHOT_DIR, 'detection.png')) ... } finally { - await browser.close().catch(() => {}) - await server.close().catch(() => {}) + await browser?.close().catch(() => {}) + await server?.close().catch(() => {}) fs.rmSync(TMP_DIR, { recursive: true, force: true }) } }Also applies to: 830-834
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/generate-readme-media.js` around lines 731 - 737, The setup of the renderer server and browser in main() (calls to startRendererServer() and chromium.launch()) must be moved inside a try block with a corresponding finally that always performs cleanup (closing the browser and shutting down the server/URL) so resources aren't leaked if startRendererServer() or chromium.launch() throws; update main() to acquire { server, url } and browser within the try, and ensure the finally calls browser?.close() and server?.close() (or the appropriate shutdown functions referenced by server/url) and preserves or sets process.exitCode as before.
778-813:⚠️ Potential issue | 🟠 Major | ⚡ Quick winHero GIF sequence conflicts with the documented capture contract.
Line 779 says detection is intentionally excluded, but
docs/assets/CAPTURE_CHECKLIST.mdLine 63 requires the hero flow to feel Mac-native with overlay + menu bar. The generator currently starts from recording/transcript flow, so it won’t produce the documented story.Suggested fix
- // Hero GIF leads with the recording state and the payoff (transcript → - // notes → Ask AI). Detection has its own screenshot in the grid, so it is - // intentionally not part of this loop to keep the hero visually distinct. + // Hero GIF should begin with detection overlay, then progress through + // recording, transcript, notes, and Ask AI to match capture docs. if (seconds < 4) { + await captureContent(page, detectionHtml(), output, GIF_VIEWPORT) + } else if (seconds < 10) { await captureUrl( page, `${url}capture.html?recording=1#/recordings`, output, GIF_VIEWPORT, 'Weekly product sync' ) - } else if (seconds < 12) { + } else if (seconds < 18) { await captureUrl( page, `${url}capture.html#/recordings/${MEETING_ID}?tab=transcript`, output, GIF_VIEWPORT, 'Jordan' ) - } else if (seconds < 20) { + } else if (seconds < 24) { await captureUrl( page, `${url}capture.html#/recordings/${MEETING_ID}?tab=notes`, output, GIF_VIEWPORT, 'Release candidate date' ) } else {🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/generate-readme-media.js` around lines 778 - 813, The hero GIF sequence in generate-readme-media.js currently starts with the recording/transcript flow and omits detection and the Mac-native overlay/menu bar required by docs/assets/CAPTURE_CHECKLIST.md; update the seconds-based branches so the initial branch (seconds < 4) captures the detection frame (use the detection route instead of `${url}capture.html?recording=1#/recordings`) and ensure the captureUrl call includes the same GIF_VIEWPORT/flags that produce the Mac-native overlay + menu bar (preserve output, url, MEETING_ID where applicable), then shift the recording/transcript/notes/ask-ai captures into the subsequent time windows so the hero GIF begins with detection and visually matches the documented capture contract.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@scripts/generate-readme-media.js`:
- Around line 731-737: The setup of the renderer server and browser in main()
(calls to startRendererServer() and chromium.launch()) must be moved inside a
try block with a corresponding finally that always performs cleanup (closing the
browser and shutting down the server/URL) so resources aren't leaked if
startRendererServer() or chromium.launch() throws; update main() to acquire {
server, url } and browser within the try, and ensure the finally calls
browser?.close() and server?.close() (or the appropriate shutdown functions
referenced by server/url) and preserves or sets process.exitCode as before.
- Around line 778-813: The hero GIF sequence in generate-readme-media.js
currently starts with the recording/transcript flow and omits detection and the
Mac-native overlay/menu bar required by docs/assets/CAPTURE_CHECKLIST.md; update
the seconds-based branches so the initial branch (seconds < 4) captures the
detection frame (use the detection route instead of
`${url}capture.html?recording=1#/recordings`) and ensure the captureUrl call
includes the same GIF_VIEWPORT/flags that produce the Mac-native overlay + menu
bar (preserve output, url, MEETING_ID where applicable), then shift the
recording/transcript/notes/ask-ai captures into the subsequent time windows so
the hero GIF begins with detection and visually matches the documented capture
contract.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 34a01c00-e1bf-410d-93ba-0262f087c3f2
📒 Files selected for processing (2)
docs/assets/CAPTURE_CHECKLIST.mdscripts/generate-readme-media.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PRIVACY.md,SECURITY.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,CHANGELOG.md, GitHub issue/PR templates, and self-hosting docs.generate-readme-mediascript so the README renders as a cohesive product page rather than placeholder copy.Test plan
PRIVACY.md,SECURITY.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,docs/SELF_HOSTING.md.github/.env.examplecomments andpackage.jsonmetadata (author,homepage)docs/design/archive links still resolve after moving internal design docs out ofdocs/superpowers/