Skip to content

docs: surface 5chan browser daemon#72

Open
tomcasaburi wants to merge 1 commit into
masterfrom
codex/docs/5chan-daemon-discoverability
Open

docs: surface 5chan browser daemon#72
tomcasaburi wants to merge 1 commit into
masterfrom
codex/docs/5chan-daemon-discoverability

Conversation

@tomcasaburi

@tomcasaburi tomcasaburi commented Jun 7, 2026

Copy link
Copy Markdown
Member

Summary

  • Make 5chan explicit in the top bitsocial-cli README summary
  • Add a short section explaining that bitsocial daemon serves the bundled 5chan Web UI in a normal browser
  • Include the 5chan WebUI URL in the Docker log example

Context: bitsocialnet/5chan#1157

Verification

  • npm ci with npm 11.13.0, matching CI
  • npm run build
  • npm run build:test
  • npm run test:cli

Note

Low Risk
README-only changes with no runtime or configuration impact.

Overview
Documentation-only update to README.md that makes the bundled 5chan Web UI easier to discover and use without the separate 5chan app.

The what is bitsocial-cli bullet now names 5chan alongside Seedit. A new Use 5chan in your normal browser section (with TOC link) explains running bitsocial daemon and opening the printed WebUI (5chan - Imageboard-style UI) URL in a normal browser.

Docker docs now show the 5chan WebUI line in the sample startup logs and tell readers to open 5chan or Seedit URLs.

Reviewed by Cursor Bugbot for commit 1cba653. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added instructions for accessing the 5chan web UI directly in a browser through the daemon's local URL.
    • Updated Docker Compose documentation to reference both 5chan and Seedit web UI options.

@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e6468539-cbf5-494d-809a-af9e05c68f71

📥 Commits

Reviewing files that changed from the base of the PR and between afd8bca and 1cba653.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md updated to document the 5chan Web UI feature. Table of contents and feature description now mention 5chan alongside Seedit; a new section explains how to start the daemon and open 5chan in a browser; Docker Compose example output is updated to include the WebUI URL.

Changes

5chan WebUI Documentation

Layer / File(s) Summary
Feature list and table of contents updates
README.md
Table of contents gains entry for new 5chan usage section; feature bullet updated to explicitly mention both 5chan and Seedit as bundled Web UIs.
5chan WebUI usage guide and Docker Compose example
README.md
New section explains how to run bitsocial daemon and open the printed 5chan WebUI URL in a normal browser without requiring the separate desktop app. Docker Compose example output updated to show the WebUI (5chan) URL alongside Seedit URL, with instruction updated to direct users to open either WebUI URL.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • bitsocialnet/bitsocial-cli#53: Both PRs modify README.md documentation for starting the daemon and showing WebUI URLs, including 5chan/seedit links and updated sample output in the Docker Compose/Running Daemon sections.

Poem

A daemon wakes, its URL gleams so bright,
5chan blooms in the browser's light,
No app to fetch, no checkout to clone—
Just click the link and make it home! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: documenting how to use the 5chan browser daemon, which is the primary focus of the README updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs/5chan-daemon-discoverability

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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