Skip to content

docs(readme): clean public entry point — remove internal doctrine notes, add Community section#79

Open
frankxai wants to merge 1 commit into
mainfrom
agent/claude/readme-cleanup
Open

docs(readme): clean public entry point — remove internal doctrine notes, add Community section#79
frankxai wants to merge 1 commit into
mainfrom
agent/claude/readme-cleanup

Conversation

@frankxai

@frankxai frankxai commented Jul 2, 2026

Copy link
Copy Markdown
Owner

The public README carried internal agent-doctrine text (visual-identity blockquote, god-mode asset notes) meant for agents, not visitors. This removes it, adds a Community section (Discussions + arcanea.ai/community), and lists arcanea-claw in the ecosystem.

🤖 Generated with Claude Code

… point, add Community section

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 2, 2026 03:46
@vercel

vercel Bot commented Jul 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
arcanea-2 Error Error Jul 2, 2026 3:47am
arcanea-web Ready Ready Preview, Comment, Open in v0 Jul 2, 2026 3:47am

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@frankxai, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 43 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3a173620-74f3-4127-9d58-cb6cd8a950c9

📥 Commits

Reviewing files that changed from the base of the PR and between 375b63b and 0667f55.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/claude/readme-cleanup

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.

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the README.md by streamlining the introduction, adding a new Community section, updating the Ecosystem section with new projects like arcanea-claw, and removing the Visual Ecosystem section. The reviewer suggested adding a Discord link to the Community section to align with CONTRIBUTING.md.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +38 to +39
- [Discussions](https://github.com/frankxai/arcanea/discussions) — questions, ideas, showcase
- [arcanea.ai/community](https://arcanea.ai/community) — how to contribute lore, agents, skills, code, art, and music

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The CONTRIBUTING.md file lists Discord (https://discord.gg/arcanea) as a primary real-time communication channel for the community. Adding it to the Community section of the main README.md ensures consistency and makes it easier for new contributors to find the chat server.

Suggested change
- [Discussions](https://github.com/frankxai/arcanea/discussions) — questions, ideas, showcase
- [arcanea.ai/community](https://arcanea.ai/community) — how to contribute lore, agents, skills, code, art, and music
- [Discussions](https://github.com/frankxai/arcanea/discussions) — questions, ideas, showcase
- [Discord](https://discord.gg/arcanea) — real-time chat and community discussion
- [arcanea.ai/community](https://arcanea.ai/community) — how to contribute lore, agents, skills, code, art, and music

Copilot AI 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.

Pull request overview

This PR cleans up the public-facing README by removing internal agent/doctrine notes and adding clear community entry points, making the repository’s landing page more appropriate for visitors and contributors.

Changes:

  • Removed internal visual-identity/doctrine blockquote and the “Visual Ecosystem” section from the public README.
  • Added a “Community” section linking to GitHub Discussions and the arcanea.ai community page.
  • Expanded the “Ecosystem” list to include arcanea-claw and repositioned/updated arcanea-orchestrator.

@claude

claude Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review: docs(readme): clean public entry point

Reviewed the diff (README.md, +8/-8). This is a clean, low-risk, docs-only change — no code, build, or security surface affected.

What looks good

  • Removing the internal agent-doctrine blockquote (visual identity, god-mode asset notes) from the public README is the right call — that content is for contributors/agents working from .github/ARCANEA_VISUAL_ECOSYSTEM.md and .arcanea/lore/VISUAL_DOCTRINE.md directly, not for a first-time visitor.
  • New "Community" section is well-placed (after the "How this relates to Arcanea" context, before "Ecosystem") and uses consistent list/link formatting with the rest of the doc.
  • Ecosystem list addition (arcanea-orchestrator description tightened, arcanea-claw added) reads clearly and matches the existing bullet style.
  • Markdown renders cleanly — headers, spacing, and list formatting are consistent with the rest of the file (verified by reading the resulting file).

Minor / non-blocking notes

  1. Orphaned doc file: .github/ARCANEA_VISUAL_ECOSYSTEM.md is no longer referenced from any markdown file in the repo after this change (confirmed via grep). Not a problem for this PR's scope, but worth a follow-up — either re-link it from an internal/contributor doc (e.g. CONTRIBUTING.md or .claude/CLAUDE.md) or fold it into docs/ if it's still meant to be discoverable by agents/contributors.
  2. Link verification: I wasn't able to verify from this sandbox that github.com/frankxai/arcanea/discussions (GitHub Discussions enabled?) and the newly-added arcanea-claw repo are live/public — worth a quick manual click-through before merge so the README doesn't ship dead links.
  3. Nit: the arcanea-orchestrator description changed from "fork used for Arcanea swarm workflows" to "for Arcanea swarm workflows" — dropping "fork used" is a small accuracy/framing change; confirm that's intentional (e.g., if it's no longer maintained as a fork, or if you just wanted tighter copy).

Test coverage: N/A — README-only change, no tests expected.

Overall: safe to merge once the two link checks above are confirmed.

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