Skip to content

Updated Helper Docs (effective after Hermit update)#2

Open
julianengel wants to merge 4 commits into
openclaw:mainfrom
julianengel:main
Open

Updated Helper Docs (effective after Hermit update)#2
julianengel wants to merge 4 commits into
openclaw:mainfrom
julianengel:main

Conversation

@julianengel
Copy link
Copy Markdown
Collaborator

Updated Helper Docs (once the new Hermit Commands are merged in)

  • Rewrite helpers/krill.md with usage tips, pre-posting checklist, and limitations
  • Add helpers/tools.md with Hermit /helper and /say commands reference
  • Add helpers/workflows.md for common helper scenarios (off-topic, long threads, unrelated help)
  • Add helpers/welcome-message.md showing the auto-posted thread welcome message

… guide

- Rewrite helpers/krill.md with usage tips, pre-posting checklist, and limitations
- Add helpers/tools.md with Hermit /helper and /say commands reference
- Add helpers/workflows.md for common helper scenarios (off-topic, long threads, unrelated help)
- Add helpers/welcome-message.md showing the auto-posted thread welcome message
@julianengel
Copy link
Copy Markdown
Collaborator Author

Depends on openclaw/hermit#5

@julianengel
Copy link
Copy Markdown
Collaborator Author

Updated to reflect new context menu suggested in hermit for marking answers as solved (via Answer Overflow) but with a log-trail.

@clawsweeper clawsweeper Bot added rating: 🦐 gold shrimp Decent PR readiness signal, but merge confidence is limited. status: ⏳ waiting on author ClawSweeper has contributor-facing work open and is waiting for author action. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. labels May 23, 2026
@clawsweeper
Copy link
Copy Markdown

clawsweeper Bot commented May 23, 2026

Codex review: found issues before merge.

Latest ClawSweeper review: 2026-05-23 00:08 UTC / May 22, 2026, 8:08 PM ET.

Workflow note: Future ClawSweeper reviews update this same comment in place.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

Summary
The branch expands helper Markdown docs with Krill usage guidance, Hermit helper command references, helper workflows, and the help-thread welcome-message template.

Reproducibility: not applicable. this is a docs PR, not a reported runtime bug. The review path is comparing the PR diff with current main docs and the linked Hermit dependency.

PR rating
Overall: 🦐 gold shrimp
Proof: 🌊 off-meta tidepool
Patch quality: 🦐 gold shrimp
Summary: Useful helper docs are present, but the branch is stale/conflicting and includes outdated operational facts that need correction before merge.

Rank-up moves:

  • Rebase onto current main and preserve the current Krill hosting/access facts.
  • Update the Hermit command references against the merged Hermit implementation and either add the missing /say section or remove that promise.
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

Real behavior proof
Not applicable: Real behavior proof is not required for this collaborator-authored Markdown-only community docs PR; the runtime behavior lives in the linked Hermit implementation.

Risk before merge

  • Merging as-is would publish outdated Krill hosting/access instructions that conflict with current main.
  • The docs were written against a Hermit PR that was later superseded by a different merged Hermit implementation, so command, env-var, and runtime wording needs reconciliation.
  • The PR is currently conflicting, so a maintainer should review the rebased document shape rather than landing the old branch directly.

Maintainer options:

  1. Decide the mitigation before merge
    Rebase the helper docs onto current main, preserve the current Krill hosting/staff-access facts, and update command, welcome-message, and Solved guidance against the merged Hermit behavior before merging.
  2. Pause or close
    Do not merge this PR until maintainers decide whether the risk is worth taking.

Next step before merge
A maintainer should decide the rebased helper-doc shape because this collaborator-authored PR overlaps newer main docs and a superseding Hermit implementation.

Security
Cleared: The diff is Markdown-only helper documentation and does not change code execution, dependencies, workflows, secrets handling, or package metadata.

Review findings

  • [P2] Keep Krill hosting details aligned with main — helpers/krill.md:7-8
  • [P3] Add or remove the missing /say command reference — helpers/tools.md:13
Review details

Best possible solution:

Rebase the helper docs onto current main, preserve the current Krill hosting/staff-access facts, and update command, welcome-message, and Solved guidance against the merged Hermit behavior before merging.

Do we have a high-confidence way to reproduce the issue?

Not applicable; this is a docs PR, not a reported runtime bug. The review path is comparing the PR diff with current main docs and the linked Hermit dependency.

Is this the best way to solve the issue?

No; the submitted branch is useful but not the best merge shape until it is rebased and corrected for current main and the merged Hermit implementation.

Label changes:

  • add P3: This is low-risk documentation and helper workflow cleanup, with no runtime code change in this repository.
  • add rating: 🦐 gold shrimp: Current PR rating is 🦐 gold shrimp because proof is 🌊 off-meta tidepool, patch quality is 🦐 gold shrimp, and Useful helper docs are present, but the branch is stale/conflicting and includes outdated operational facts that need correction before merge.
  • add status: ⏳ waiting on author: ClawSweeper has contributor-facing work open and is waiting for author action. Not applicable: Real behavior proof is not required for this collaborator-authored Markdown-only community docs PR; the runtime behavior lives in the linked Hermit implementation.

Label justifications:

  • P3: This is low-risk documentation and helper workflow cleanup, with no runtime code change in this repository.
  • rating: 🦐 gold shrimp: Current PR rating is 🦐 gold shrimp because proof is 🌊 off-meta tidepool, patch quality is 🦐 gold shrimp, and Useful helper docs are present, but the branch is stale/conflicting and includes outdated operational facts that need correction before merge.
  • status: ⏳ waiting on author: ClawSweeper has contributor-facing work open and is waiting for author action. Not applicable: Real behavior proof is not required for this collaborator-authored Markdown-only community docs PR; the runtime behavior lives in the linked Hermit implementation.

Full review comments:

  • [P2] Keep Krill hosting details aligned with main — helpers/krill.md:7-8
    This branch rewrites the Krill hosting section back to exe.dev/Peter's account and says only Shadow has access, but current main now documents Krill as hosted on Julian's Hetzner instance and says Community Staff may ping it for support. Please rebase and preserve the current operational facts while adding the helper guidance.
    Confidence: 0.89
  • [P3] Add or remove the missing /say command reference — helpers/tools.md:13
    The PR body promises a /say commands reference, and this intro says Hermit provides three command groups, but this file only documents /helper and Solved (Mod). Either add the /say section or narrow the wording so helpers do not look for missing docs.
    Confidence: 0.78

Overall correctness: patch is incorrect
Overall confidence: 0.86

Acceptance criteria:

  • Review the rendered Markdown after rebase.
  • Confirm command names, welcome-message text, and env-var names against openclaw/hermit main.

What I checked:

  • Current main Krill facts: Current main says Krill is hosted on Julian's Hetzner instance and that Community Staff can ping Krill in any channel for support, triage, or member guidance. (helpers/krill.md:1, bd2eda8e70c3)
  • Stale PR diff: The PR branch rewrites the same file to say Krill is hosted on exe.dev on Peter's account and only Shadow has access, which conflicts with current main's newer operational facts. (helpers/krill.md:7, bbd339bfcc73)
  • Hermit dependency was superseded: The PR discussion says it depends on New Helper Functions & Welcome Message for Hermit in #help Channel hermit#5; that Hermit PR was closed after the contributor linked Add Hermit-managed thread length monitoring hermit#6 as the up-to-date replacement, and the replacement merged on 2026-04-08. (4623b5c43281)
  • Current Hermit operations docs: Main now documents Hermit as a Cloudflare Worker plus gateway forwarder, including helper-thread welcome handling and D1/deploy operations, so helper docs need to align with the newer operational model. (bot-management.md:31, bd2eda8e70c3)
  • Feature history: git history shows the Krill and Hermit docs were substantially updated after the PR base by dc67fb0, f55dcd1, and bd2eda8 on current main. (dc67fb04f8e3)
  • Review state: GitHub shows the PR was approved at commit cf8cd87, but the PR is now CONFLICTING and was not re-reviewed after current main added newer community and Hermit docs. (cf8cd87ee1d7)

Likely related people:

  • thewilloftheshadow: Shadow authored the current main updates to helpers/krill.md and bot-management.md and reviewed this PR before main moved on. (role: recent area contributor and reviewer; confidence: high; commits: dc67fb04f8e3, f55dcd1c9d1c, bd2eda8e70c3; files: helpers/krill.md, bot-management.md)
  • julianengel: Julian authored the community helper-doc branch and also authored the merged Hermit helper-command, welcome-message, and Solved (Mod) work that these docs describe. (role: helper workflow feature contributor; confidence: medium; commits: 2335c6dfb393, c297aa5233c8, 158bd3e3d197; files: helpers/krill.md, helpers/tools.md, helpers/workflows.md)

Codex review notes: model gpt-5.5, reasoning high; reviewed against bd2eda8e70c3.

@clawsweeper
Copy link
Copy Markdown

clawsweeper Bot commented May 23, 2026

ClawSweeper PR egg

🔥 Warming up: real-behavior proof passed; findings, security review, or rank-up moves are still in progress.

Hatch command

Comment @clawsweeper hatch when this PR is hatchable.

Hatchability rules:

  • Merged PRs are hatchable.
  • Open PRs are hatchable when they are status: 👀 ready for maintainer look, status: 🚀 automerge armed, or labeled clawsweeper:automerge.
  • Closed unmerged PRs are hatchable only when one of those hatchable labels is still present in the durable record.
What is this egg doing here?
  • Eggs appear after the PR passes real-behavior proof. It is here for vibes, not verdicts: it does not change labels, ratings, merge decisions, or automation.
  • The shell reacts to review momentum: open follow-up work warms it up, re-review makes it wobble, and a clean final review lets it hatch.
  • Hatchability usually comes from sufficient real-behavior proof, no blocking P0/P1/P2 findings, no security attention needed, and clean correctness. A merged PR is already final, so merge makes the egg hatchable independently.
  • The hatch is seeded from this repository and PR number, so the same PR keeps the same creature; the reviewed head SHA can only change safe visual details.
  • Rarity is just collectible sparkle: 🥚 common, 🌱 uncommon, 💎 rare, ✨ glimmer, and 🌈 legendary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🦐 gold shrimp Decent PR readiness signal, but merge confidence is limited. status: ⏳ waiting on author ClawSweeper has contributor-facing work open and is waiting for author action.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants