Skip to content

Update README.md#53

Merged
Rinse12 merged 2 commits into
masterfrom
update-readme-1
May 24, 2026
Merged

Update README.md#53
Rinse12 merged 2 commits into
masterfrom
update-readme-1

Conversation

@tomcasaburi

@tomcasaburi tomcasaburi commented May 24, 2026

Copy link
Copy Markdown
Member

Note

Low Risk
Documentation-only changes updating paths, log output examples, and WebUI/CLI references; no runtime or behavior changes.

Overview
Updates README.md to reflect current naming/output: replaces plebbit references with pkc, updates the container data path for community DBs, and refreshes daemon startup log/WebUI examples (including 5chan).

Also updates CLI command examples/sample community identifiers throughout to match the current docs and terminology.

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

Summary by CodeRabbit

  • Documentation
    • Updated CLI command examples to reflect current terminology and community identifiers.
    • Revised Docker configuration paths and startup log examples.
    • Refreshed daemon output samples and WebUI reference links.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 24, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

README.md documentation examples are updated to adopt PKC terminology and standardized sample community addresses. Docker infrastructure paths and RPC labels are refreshed, and CLI command examples across create, list, delete, get, start, and stop operations now consistently reference anime-and-manga.bso with updated output text.

Changes

Documentation Examples for PKC Terminology and Community Addresses

Layer / File(s) Summary
Docker and Daemon Documentation
README.md
Docker data paths table switches from /data/bitsocial/subplebbits to /data/bitsocial/communities. Docker Compose and Running Daemon examples update RPC labels from plebbit rpc to pkc rpc, refresh the example communities list, and add 5chan WebUI sample URLs alongside seedit.
CLI Command Examples
README.md
CLI command examples for community list, community create, community delete, community get, community start, and community stop are updated to use consistent sample community address anime-and-manga.bso (replacing prior addresses like plebbit.bso and plebmusic.bso) with refreshed output text and example descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs with glee,
PKC whispers, "Come and see!"
Communities bloom where plebs once grew,
anime-and-manga shines brand new! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update README.md' is vague and generic, using non-descriptive language that doesn't convey the specific nature of the changes (PKC terminology updates, Docker path documentation, CLI examples refresh). Provide a more descriptive title that captures the main changes, such as 'Update README with PKC terminology and refresh CLI examples' or 'Update documentation for PKC naming and example community addresses'.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-readme-1

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 `@README.md`:
- Line 246: Update the README sentence containing "bitsocial daemon" that
currently uses the misspelled word "interopable" and replace it with
"interoperable"; locate the sentence that reads "Once `bitsocial daemon` is
running, you can create and manage your communities through the web interfaces,
either seedit or 5chan. All the interfaces are interopable." and edit it so the
final clause reads "All the interfaces are interoperable." to correct the
user-facing documentation.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4cb1ea2d-2f47-4d25-a171-33db2552a105

📥 Commits

Reviewing files that changed from the base of the PR and between 2a08e93 and 8168f62.

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

Comment thread README.md Outdated
@Rinse12 Rinse12 merged commit 6b1aa0c into master May 24, 2026
2 checks passed
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.

2 participants