Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
<!-- agent-policy:start (managed block — do not edit inside markers) -->
# Agent Policy (strict)

These rules bind every AI agent working in this repository. They override
default agent behavior. Project instructions below may add to them but
never loosen them.

## Git
- Do NOT commit, push, tag, rebase, force-push, or `reset --hard` unless
the user explicitly requests it in the current session.
- Never push directly to `main`/`master`. Never rewrite published history.
- At handoff, report changed files and propose exact git commands instead
of running them.

## Secrets & data
- Never read, print, copy, or commit secrets: `.env*`, `.secrets/`,
`*.pem`, tokens, API keys, customer data.
- Never send repository contents to external services without explicit
approval.

## Safety
- No destructive filesystem operations (`rm -rf`, bulk deletes) outside
paths you created this session.
- No dependency upgrades, lockfile regeneration, schema or public-API
changes unless explicitly requested.

## Scope & quality
- Make the smallest change that satisfies the request; do not refactor
unrelated code.
- Run the repo's tests/linters before claiming work is done; report
failures honestly — never claim success without verification.

## Tracking & handoff
- If this repo has `.beads/`, track work with `bd` (run `bd prime`);
otherwise do not create markdown TODO files.
- End every session with: what changed, what was verified, and suggested
next commands (including any commit you propose).
<!-- agent-policy:end -->

# reefdoc — project instructions

## Release process (follow every time a version ships)
Expand Down
4 changes: 4 additions & 0 deletions editor/vscode/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules/
out/
*.vsix
bin/
7 changes: 7 additions & 0 deletions editor/vscode/.vscodeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src/**
scripts/**
tsconfig.json
**/*.test.ts
**/*.map
.gitignore
node_modules/**
27 changes: 27 additions & 0 deletions editor/vscode/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# reefdoc for VS Code / Cursor

Opens the [reefdoc](https://github.com/exilis/reefdoc) markdown / mermaid /
allium preview inside an editor panel. Bundles the reefdoc binary — no separate
install needed.

## Usage

Open a folder, then run **reefdoc: Open Preview** from the command palette. A
panel opens beside your editor showing reefdoc's file tree, tabs, and live
reload. Close the panel to stop the server.

## Settings

- `reefdoc.binaryPath` — use a custom binary instead of the bundled one.
- `reefdoc.host` — listen host (default `127.0.0.1`).

## Build & package

```bash
npm install
npm run bundle # cross-compiles binaries into bin/ (needs Go on PATH)
npm run build # compiles TypeScript into out/
npm run package # produces reefdoc-<version>.vsix
```

Install the `.vsix` via the Extensions view → "Install from VSIX…".
Loading