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
53 changes: 53 additions & 0 deletions .claude/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
== `+.claude/+` — Claude Code project configuration

Checked-in, team-shared configuration for Claude Code sessions on
typed-wasm.

=== Contents

[width="100%",cols="40%,60%",options="header",]
|===
|Path |Purpose
|`+CLAUDE.md+` |Project instructions (overview, architecture,
build/test, the 10 levels).

|`+settings.json+` |Permissions allowlist + hooks (see below).

|`+hooks/governance-precheck.sh+` |Local mirror of two CI governance
gates.
|===

=== `+settings.json+`

==== Permissions (`+permissions.allow+`)

A *read-only* allowlist that cuts permission prompts for the inspection
commands used routinely in this repo:
`+git status/log/diff/fetch/show/ls-files/ls-tree/branch/rev-parse/ merge-base/for-each-ref/check-attr+`,
`+git bundle verify+`/`+list-heads+`, `+diff -rq+`, and `+curl+`
*restricted to `+https://raw.githubusercontent.com/+`* (used to compare
sibling-estate repos without a full clone). No write, push, or
destructive commands are granted — those still prompt.

==== Hooks (`+hooks.SessionStart+`)

Runs `+hooks/governance-precheck.sh+` at session start. *Advisory only —
never blocks, always exits 0.* It surfaces, before you push, the two CI
gates most easily tripped by docs changes:

[arabic]
. *Empty-linter* — invisible/zero-width Unicode (NBSP, ZWSP, BOM, bidi
marks, NUL) in source files, using the exact byte patterns from
`+.github/workflows/dogfood-gate.yml+`.
. *SPDX headers* — `+SPDX-License-Identifier+` presence on any `+.md+` /
`+.sh+` / `+.adoc+` *changed vs `+origin/main+`* (the push delta — not
the whole tree, to avoid the pre-existing unlicensed-doc backlog and
stay accurate to "`catch before push`").

Review or disable hooks anytime via the `+/hooks+` menu.

____
Note: the settings watcher only picks up `+.claude/settings.json+` if it
existed when the session started. On the session that first adds this
file, open `+/hooks+` once (or restart) to load the hook.
____
42 changes: 0 additions & 42 deletions .claude/README.md

This file was deleted.

48 changes: 48 additions & 0 deletions ARCHITECTURE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
== Architecture

=== Overview

This repository follows a modular, maintainable architecture designed
for clarity, scalability, and long-term sustainability.

=== Directory Structure

....
.
├── src/ # Source code
├── tests/ # Test suites
├── docs/ # Documentation
├── scripts/ # Utility scripts
├── config/ # Configuration files
├── LICENSE # License file
├── LICENSES/ # Full license texts
└── README.adoc # Project documentation
....

=== Design Principles

* *Separation of Concerns*: Each module has a single responsibility
* *Testability*: Code is written to be easily testable
* *Documentation*: All public APIs are documented
* *Configuration*: Environment-specific settings are externalized

=== Dependencies

* External dependencies are minimized and clearly declared
* Version pinning is used for reproducibility

=== Security Considerations

* Sensitive data is never committed to the repository
* Secrets are managed through environment variables or secure vaults
* Regular dependency audits are performed

=== Maintainability

* Code follows consistent style guidelines
* Pull requests require review and CI checks
* Issues and discussions are tracked transparently

'''''

_Last updated: 2026-07-18_
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

Loading
Loading