Skip to content

docs(readme): refresh public community entry points - #88

Open
frankxai wants to merge 1 commit into
mainfrom
docs/arcanea-public-readme-community-20260803
Open

docs(readme): refresh public community entry points#88
frankxai wants to merge 1 commit into
mainfrom
docs/arcanea-public-readme-community-20260803

Conversation

@frankxai

@frankxai frankxai commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • removes internal visual-doctrine and generated-asset language from the public README
  • adds verified GitHub Discussions and community entry points
  • refreshes the public ecosystem list with verified Arcanea-owned repositories

Verification

  • git diff --check
  • README structural assertions (community links and removed internal section)
  • independent Claude Sonnet 5 read-only review: PASS; no security, correctness, or truthfulness blockers
  • live link/API checks: GitHub Discussions 200; arcanea.ai/community redirects to www.arcanea.ai/community 200; arcanea-claw and arcanea-orchestrator public/non-archived metadata verified

Release boundary

Docs-only public-repository change. No package install, build, runtime, deployment, or production release was performed.

Supersedes #79, whose identical intent was based on stale main and stale failed checks.

Summary by CodeRabbit

  • Documentation
    • Updated the repository description and improved README formatting.
    • Added community discussion and contribution links.
    • Expanded and reordered the ecosystem list with new and updated project information.

@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@coderabbitai

coderabbitai Bot commented Aug 3, 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 Plus

Run ID: 5ae01ec1-3a93-4c7f-badb-765178402bde

📥 Commits

Reviewing files that changed from the base of the PR and between 7510802 and 3b7b5fa.

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

📝 Walkthrough

Walkthrough

The README description was revised. The visual-identity blockquote was removed. Community links were added. The Ecosystem list now includes arcanea-claw and an updated arcanea-orchestrator description.

Changes

README content

Layer / File(s) Summary
README sections
README.md
The repository description uses an em dash. The visual-identity blockquote was removed. Community links were added. The Ecosystem list was expanded and reordered. The arcanea-orchestrator description now refers to multi-agent swarm workflows.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the README update to public community entry points.
Description check ✅ Passed The description clearly explains the documentation changes, verification steps, and release boundary, although it uses different headings from the template.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/arcanea-public-readme-community-20260803

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.

@claude

claude Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review

Small, well-scoped docs-only change to README.md (8 additions / 8 deletions). Reviewed against the PR's stated verification steps.

Code quality & conventions

  • Clean, consistent Markdown — new ## Community section fits the existing heading style and list formatting used elsewhere in the file.
  • The dropped > Premium visual identity per .github/ARCANEA_VISUAL_ECOSYSTEM.md (...) blockquote and ## Visual Ecosystem section only remove the README's pointer to that doc — .github/ARCANEA_VISUAL_ECOSYSTEM.md itself is untouched, so no dangling file, just a lost discoverability path from the README. Worth double-checking that's intentional (matches the PR summary's "removes internal visual-doctrine ... language from the public README").
  • arcanea-orchestrator description changed from "fork used for Arcanea swarm workflows" → "multi-agent orchestration for Arcanea swarm workflows" — softer/more accurate public framing, no objection.

Potential issues

  • None found. The three new/changed links (github.com/frankxai/arcanea/discussions, arcanea.ai/community, arcanea-claw, arcanea-orchestrator) aren't referenced inconsistently anywhere else in the repo's docs, and the PR description states they were live-checked (200s / non-archived repo metadata).
  • Minor nit (non-blocking): the ecosystem list mixes a colon (arcanea-code:) and no-colon-with-em-dash style inconsistently across entries — pre-existing, not introduced by this PR.

Performance / Security

  • N/A — Markdown-only change, no code, no secrets, no build/runtime impact. Matches the "Release boundary: Docs-only public-repository change" note in the PR description.

Test coverage

  • N/A for a README change. git diff --check was already run per the PR description (no whitespace errors).

Overall: straightforward, verified, low-risk. LGTM.

@frankxai

frankxai commented Aug 3, 2026

Copy link
Copy Markdown
Owner Author

Merge Queen receipt — current head assessed

Exact head: 3b7b5fa1764d27e7798a5f1f1500cd29e381d378 against current main 7510802104165525df4aa46e6580eac6b36b29f9; one file, README.md (+8/−8). Remote branch ref matches this SHA.

Independent acceptance:

  • Local bounded Claude Sonnet 5 review: PASS, no security/correctness/truthfulness blocker.
  • GitHub Claude Code Review at the exact head: PASS / LGTM; CodeRabbit reported no actionable comments.
  • Quality Gate: PASS — install, TypeScript/package tests, production build, and quality status all succeeded.
  • git diff --check, structural README assertions, and live destination checks passed before push.

Shared CI baseline incident (not authored by this docs diff): Arcanea Test Suite fails at node --test packages/*/tests/*.test.mjs because imports for unbuilt packages/agent-bus/dist/index.js and packages/token-optimizer/dist/index.js are missing. The current test.yml builds an enumerated subset that omits those packages, then executes every package test; the changed-file scope is README-only. CLI Tests (20) and dependent Test Summary are therefore baseline-blocked, not a README regression. No CI bypass or workflow change was made here.

Disposition: HOLD, not merged. Branch protection requires one distinct approving review; the active frankxai identity authored this PR and cannot self-approve. In addition, the shared CLI workflow baseline needs a separately scoped repair/current-main proof before this PR can be considered fully green. No protection bypass, deployment, or production release occurred.

@frankxai

frankxai commented Aug 7, 2026

Copy link
Copy Markdown
Owner Author

PR hospital triage 2026-08-07 — PARK / needs-rebase (docs-only lane)

Disposition: needs-rebase — otherwise this is the only docs-only ready candidate.

  • Scope is README-only public community entry points (safe docs).
  • Blocked: CONFLICTING with main + some CI failures on suite (may be baseline).
  • Label suggestion: needs-rebase · ship-candidate-docs

After rebase onto current main and green docs-relevant checks, this is eligible for squash merge under the docs-only arcanea rule.

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