Skip to content

Commit 0aab4d6

Browse files
committed
docs: add OpenWiki codebase documentation
1 parent 4dc4958 commit 0aab4d6

35 files changed

Lines changed: 6905 additions & 0 deletions

‎.openwikiignore‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Secrets and local configuration
2+
.env
3+
.env.*
4+
!.env.example
5+
!*.env.example
6+
*.pem
7+
*.key
8+
*.crt
9+
*.log
10+
11+
# Dependencies, generated output, caches, and local tooling
12+
node_modules/
13+
**/node_modules/
14+
dist/
15+
**/dist/
16+
build/
17+
**/build/
18+
coverage/
19+
**/coverage/
20+
.next/
21+
**/.next/
22+
out/
23+
**/out/
24+
.turbo/
25+
**/.turbo/
26+
.git/
27+
.idea/
28+
.vscode/
29+
packages/webdecoy/output/
30+
31+
# Local operating-system files
32+
.DS_Store
33+
Thumbs.db
34+
*.swp
35+
*.swo
36+

‎AGENTS.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,16 @@ two.
146146

147147
In monitor mode this is the only place the verdict surfaces, so an app that
148148
wants to log or meter denials reads it here.
149+
150+
<!-- OPENWIKI:START -->
151+
152+
## OpenWiki
153+
154+
This repository has a generated `openwiki/` evidence index. It is optional just-in-time context, not required startup reading.
155+
156+
- Treat source code and tests as authoritative. A brief's unknowns and review items are verification gaps, not automatic requirements.
157+
- Prefer the narrowest quiet validation that proves the changed behavior. Preserve complete failure output.
158+
159+
OpenWiki updates are run manually with `OPENWIKI_TELEMETRY_DISABLED=1 openwiki --update`. Do not hand-edit generated OpenWiki pages unless explicitly asked; prefer updating source code/docs and regenerating the wiki.
160+
161+
<!-- OPENWIKI:END -->

‎CLAUDE.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!-- OPENWIKI:START -->
2+
3+
## OpenWiki
4+
5+
See [AGENTS.md](AGENTS.md) for OpenWiki agent instructions.
6+
7+
<!-- OPENWIKI:END -->

‎openwiki/.claims/architecture/packages-and-runtime-boundaries.json‎

Lines changed: 338 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/concepts/bot-identity-policy-and-web-bot-auth.json‎

Lines changed: 292 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/concepts/captcha-and-browser-signals.json‎

Lines changed: 352 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/concepts/client-identity-proxy-trust-and-edge-context.json‎

Lines changed: 304 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/concepts/request-decisions-and-enforcement.json‎

Lines changed: 306 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/concepts/rules-rate-limits-and-deception.json‎

Lines changed: 342 additions & 0 deletions
Large diffs are not rendered by default.

‎openwiki/.claims/integrations/framework-adapters.json‎

Lines changed: 610 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)