Skip to content

docs: add CLAUDE.md with wiki references#12

Open
ziomancer wants to merge 1 commit intomasterfrom
docs/wiki-references
Open

docs: add CLAUDE.md with wiki references#12
ziomancer wants to merge 1 commit intomasterfrom
docs/wiki-references

Conversation

@ziomancer
Copy link
Copy Markdown
Owner

@ziomancer ziomancer commented Apr 14, 2026

Summary

  • Adds CLAUDE.md pointing CC sessions to the vigil-harbor-wiki for architecture, state, and filemap context before implementation work
  • Covers build/run/test, architecture overview, key conventions, and wiki section

Test plan

  • Verify CLAUDE.md is picked up by CC on session start

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated internal developer documentation.

Note: No user-facing changes in this release.

Points Claude Code to the vigil-harbor-wiki for architecture,
state, and filemap context before implementation work.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 14, 2026

📝 Walkthrough

Walkthrough

A new CLAUDE.md documentation file was added describing the repository as a two-package monorepo implementing a session-aware content sanitization pipeline, detailing the architecture, pipeline flow, module organization, operational concepts, TypeScript conventions, and implementation guidelines.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
New documentation file describing repository structure (monorepo with npm library and OpenClaw plugin), pipeline architecture (trust check → pre-filter → frequency tracking → validation → scanning → sanitization → auditing → alert evaluation), key modules, configuration profiles, TypeScript/ESM conventions, and implementation checklists.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A guide we've penned, clear and bright,
Describing pipelines, pure and tight,
With monorepo maps and flows so clean,
The finest docs you've ever seen!
Now Claude can hop through code with glee,
Understanding perfectly! 🌿

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 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: adding a CLAUDE.md documentation file with wiki references. It is concise, clear, and directly summarizes the primary modification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 docs/wiki-references

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Around line 37-42: The fenced pipeline block uses triple backticks without a
language tag which triggers markdownlint rule MD040; update the fenced code
block around the pipeline diagram (the triple-backtick block containing "Trust
check → Syntactic pre-filter..." lines) to include a language identifier such as
text (e.g., replace ``` with ```text) so the block is explicitly annotated and
MD040 is resolved.
- Around line 74-75: Replace the machine-specific absolute path
"C:\Users\zioni\Documents\Vigil-Harbor\vigil-harbor-wiki" in CLAUDE.md with a
portable repo-relative or configurable reference (e.g., "./vigil-harbor-wiki" or
use an env var placeholder like "$WIKI_PATH") and update the sentence to
instruct contributors to clone or symlink the wiki into that repo-relative
location or set the env var; ensure the README line and any examples reference
the chosen convention consistently so CI/devcontainer and other contributors can
follow it.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 72556d67-fc10-4290-8bc8-d90f0855568e

📥 Commits

Reviewing files that changed from the base of the PR and between ecc2ba7 and 7be9e76.

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

Comment thread CLAUDE.md
Comment on lines +37 to +42
```
Trust check → Syntactic pre-filter (17 rules, NFKC normalized)
→ Frequency update → Two-pass gate → Schema validation (MCP)
→ Scanner (ClawMoat) → Frequency update → Sanitize (redact)
→ Audit events → Alert evaluation → PipelineResult
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add a language identifier to the fenced pipeline block.

This block triggers MD040 and will keep markdownlint noisy until fixed.

Suggested patch
-```
+```text
 Trust check → Syntactic pre-filter (17 rules, NFKC normalized)
 → Frequency update → Two-pass gate → Schema validation (MCP)
 → Scanner (ClawMoat) → Frequency update → Sanitize (redact)
 → Audit events → Alert evaluation → PipelineResult
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 37-37: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 37 - 42, The fenced pipeline block uses triple
backticks without a language tag which triggers markdownlint rule MD040; update
the fenced code block around the pipeline diagram (the triple-backtick block
containing "Trust check → Syntactic pre-filter..." lines) to include a language
identifier such as text (e.g., replace ``` with ```text) so the block is
explicitly annotated and MD040 is resolved.

Comment thread CLAUDE.md
Comment on lines +74 to +75
The Vigil Harbor wiki lives at `C:\Users\zioni\Documents\Vigil-Harbor\vigil-harbor-wiki`.
Read `SCHEMA.md` for conventions and maintenance rules.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Avoid a machine-specific wiki path in shared docs.

C:\Users\... only works on one workstation; this makes the guidance non-portable for other contributors and CI/devcontainer setups. Prefer a repo-relative convention or a configurable env var.

Suggested patch
-The Vigil Harbor wiki lives at `C:\Users\zioni\Documents\Vigil-Harbor\vigil-harbor-wiki`.
+The Vigil Harbor wiki lives in your local clone of `vigil-harbor-wiki` (set `VIGIL_HARBOR_WIKI_PATH` to its absolute path).
+Example:
+`$VIGIL_HARBOR_WIKI_PATH`
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 74 - 75, Replace the machine-specific absolute path
"C:\Users\zioni\Documents\Vigil-Harbor\vigil-harbor-wiki" in CLAUDE.md with a
portable repo-relative or configurable reference (e.g., "./vigil-harbor-wiki" or
use an env var placeholder like "$WIKI_PATH") and update the sentence to
instruct contributors to clone or symlink the wiki into that repo-relative
location or set the env var; ensure the README line and any examples reference
the chosen convention consistently so CI/devcontainer and other contributors can
follow it.

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