Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CODEOWNERS — hummbl-dev/docs
# CODEOWNERS — hummbl-io/docs
# Review authority per path.
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Default owners for everything
* @hummbl-dev
* @hummbl-io
56 changes: 39 additions & 17 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,55 @@
> **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project.
> For Mintlify product knowledge (components, configuration, writing standards),
> install the Mintlify skill: `npx skills add https://mintlify.com/docs`
# AGENTS.md — hummbl-io/docs

# Documentation project instructions
## Project

## About this project
**hummbl-io/docs** — Canonical public documentation for HUMMBL AI governance infrastructure. Built with [Mintlify](https://mintlify.com) and deployed from the default branch.

- This is a documentation site built on [Mintlify](https://mintlify.com)
- Pages are MDX files with YAML frontmatter
- Configuration lives in `docs.json`
- Use the Mintlify MCP server, `https://mcp.mintlify.com`, to edit content and settings via MCP
- Use the Mintlify docs MCP server, `https://www.mintlify.com/docs/mcp`, to query information about using Mintlify via MCP
## Scope

- In scope: Mintlify documentation pages (`.mdx`), `docs.json` navigation config, compliance framework docs, API reference, governance primitive docs, Base120 model docs, claim-evidence ledger
- Out of scope: Marketing site content (lives on hummbl.io), internal governance docs, product code

## Setup

```bash
npm i -g mint
mint dev
```

Preview at `http://localhost:3000`.

## Terminology
## Testing

{/* Add product-specific terms and preferred usage */}
{/* Example: Use "workspace" not "project", "member" not "user" */}
```bash
# Navigation integrity — checks every docs.json page reference resolves to an existing .mdx file
python3 scripts/validate_docs.py

## Style preferences
# Claim-surface check — flags stale quantitative claims
python3 scripts/check_claims.py
```

{/* Add any project-specific style rules below */}
Run both before pushing to `main`. CI runs them on every PR.

## Conventions

- Pages are MDX files with YAML frontmatter
- Configuration lives in `docs.json`
- Use active voice and second person ("you")
- Keep sentences concise — one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click **Settings**
- Code formatting for file names, commands, paths, and code references
- Commit format: Conventional Commits
- Branch naming: `type/agent/short-desc`
- No vendor attribution in commits or PRs

## Content boundaries

{/* Define what should and shouldn't be documented */}
{/* Example: Don't document internal admin features */}
- Document public governance primitives, compliance frameworks, API, and tools only
- Do not document internal admin features, private repo architecture, or operator workflows
- All quantitative claims (test counts, primitive counts, compliance coverage) must cite the claim-evidence ledger or current primary source
- Reference only public repos (hummbl-io/*) — never reference private repos in public docs

## Publishing

Changes pushed to `main` are deployed to production automatically via the Mintlify GitHub App. Do not push to `main` without review.
16 changes: 8 additions & 8 deletions CLAIM_LEDGER.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ This file tracks public-facing claims in HUMMBL documentation. Every compliance,

| Claim | Location | Source-of-record | Last verified | Confidence |
|---|---|---|---|---|
| 34 governance primitives across 10 categories | `introduction.mdx` | [hummbl-governance/CLAUDE.md](https://github.com/hummbl-dev/hummbl-governance/blob/main/CLAUDE.md) | 2026-07-11 | High — matches current source |
| Maps to NIST AI RMF | `introduction.mdx` | [hummbl-governance/docs/nist-rmf-mapping.md](https://github.com/hummbl-dev/hummbl-governance/blob/main/docs/nist-rmf-mapping.md) | 2026-07-11 | High — mapping doc exists |
| Maps to ISO 42001 | `introduction.mdx` | [hummbl-governance/docs/iso27001-mapping.md](https://github.com/hummbl-dev/hummbl-governance/blob/main/docs/iso27001-mapping.md) | 2026-07-11 | Medium — ISO 27001 mapping exists; 42001 crosswalk in progress |
| Maps to EU AI Act | `introduction.mdx` | [hummbl-governance/docs/coverage/](https://github.com/hummbl-dev/hummbl-governance/tree/main/docs/coverage) | 2026-07-11 | Medium — coverage docs exist |
| Maps to SOC 2 | `introduction.mdx` | [hummbl-governance/docs/soc2-mapping.md](https://github.com/hummbl-dev/hummbl-governance/blob/main/docs/soc2-mapping.md) | 2026-07-11 | High — mapping doc exists |
| 120 Base120 reasoning models | `introduction.mdx` | [hummbl-agent/registry.json](https://github.com/hummbl-dev/hummbl-agent) | 2026-07-11 | High — registry validated in CI |
| Zero third-party runtime dependencies | `introduction.mdx` | [hummbl-governance/pyproject.toml](https://github.com/hummbl-dev/hummbl-governance/blob/main/pyproject.toml) | 2026-07-11 | High — enforced by dep-check |
| 2027 collected tests (hummbl-governance) | `quickstart.mdx` | [hummbl-governance README](https://github.com/hummbl-dev/hummbl-governance#readme) | 2026-07-11 | High — matches current source |
| 34 governance primitives across 10 categories | `introduction.mdx` | [hummbl-governance/CLAUDE.md](https://github.com/hummbl-io/hummbl-governance/blob/main/CLAUDE.md) | 2026-07-11 | High — matches current source |
| Maps to NIST AI RMF | `introduction.mdx` | [hummbl-governance/docs/nist-rmf-mapping.md](https://github.com/hummbl-io/hummbl-governance/blob/main/docs/nist-rmf-mapping.md) | 2026-07-11 | High — mapping doc exists |
| Maps to ISO 42001 | `introduction.mdx` | [hummbl-governance/docs/iso27001-mapping.md](https://github.com/hummbl-io/hummbl-governance/blob/main/docs/iso27001-mapping.md) | 2026-07-11 | Medium — ISO 27001 mapping exists; 42001 crosswalk in progress |
| Maps to EU AI Act | `introduction.mdx` | [hummbl-governance/docs/coverage/](https://github.com/hummbl-io/hummbl-governance/tree/main/docs/coverage) | 2026-07-11 | Medium — coverage docs exist |
| Maps to SOC 2 | `introduction.mdx` | [hummbl-governance/docs/soc2-mapping.md](https://github.com/hummbl-io/hummbl-governance/blob/main/docs/soc2-mapping.md) | 2026-07-11 | High — mapping doc exists |
| 120 Base120 reasoning models | `introduction.mdx` | [hummbl-agent/registry.json](https://github.com/hummbl-io/hummbl-agent) | 2026-07-11 | High — registry validated in CI |
| Zero third-party runtime dependencies | `introduction.mdx` | [hummbl-governance/pyproject.toml](https://github.com/hummbl-io/hummbl-governance/blob/main/pyproject.toml) | 2026-07-11 | High — enforced by dep-check |
| 2027 collected tests (hummbl-governance) | `quickstart.mdx` | [hummbl-governance README](https://github.com/hummbl-io/hummbl-governance#readme) | 2026-07-11 | High — matches current source |
| 148 tests (hummbl-base120) | `quickstart.mdx` | hummbl-base120 source | 2026-07-11 | Medium — verify against source |

## Retired/superseded claims
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,16 @@ Both scripts are reproducible locally by agents. Run them before pushing to `mai

### Claim-evidence policy

Public docs that make compliance, primitive-count, test-count, or product capability claims must cite the internal evidence ledger or current primary source. See:
Public docs that make compliance, primitive-count, test-count, or product capability claims must cite the evidence ledger or current primary source. See:

- `hummbl-dev/hummbl-governance` — governance primitives source
- `hummbl-dev/founder-mode` — integration testbed and canonical test counts
- `hummbl-dev/claim-evidence-ledger` — claim tracking
- [`hummbl-io/hummbl-governance`](https://github.com/hummbl-io/hummbl-governance) — governance primitives source
- [`hummbl-io/claim-evidence-ledger`](https://github.com/hummbl-io/claim-evidence-ledger) — claim tracking

## Related surfaces

- [`hummbl-dev/mintlify-docs`](https://github.com/hummbl-dev/mintlify-docs) — staging/experimental docs surface
- [`hummbl-dev/hummbl-dev`](https://github.com/hummbl-dev/hummbl-dev) — org-level README and public metadata
- [`hummbl-dev/hummbl-production`](https://github.com/hummbl-dev/hummbl-production) — production deployment configs
- [`hummbl-io/mintlify-docs`](https://github.com/hummbl-io/mintlify-docs) — staging/experimental docs surface
- [`hummbl-io/hummbl-io`](https://github.com/hummbl-io/hummbl-io) — org-level README and public metadata
- [`hummbl-io/hummbl-production`](https://github.com/hummbl-io/hummbl-production) — production deployment configs

## Contributing

Expand All @@ -67,7 +66,7 @@ Public docs that make compliance, primitive-count, test-count, or product capabi

**Reuben Bowlby** — Founder, [HUMMBL](https://github.com/hummbl-io)

- GitHub: [@hummbl-dev](https://github.com/hummbl-dev)
- GitHub: [@hummbl-io](https://github.com/hummbl-io)
- X/Twitter: [@ReubenBowlby](https://x.com/ReubenBowlby)
- LinkedIn: [reuben-bowlby](https://www.linkedin.com/in/reuben-bowlby/)
- Website: [hummbl.io](https://www.hummbl.io)
2 changes: 1 addition & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"navbar": {
"primary": {
"type": "github",
"href": "https://github.com/hummbl-dev"
"href": "https://github.com/hummbl-io"
}
},
"navigation": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Status: draft PR promotion
Source issue: #1
Issue URL: https://github.com/hummbl-dev/docs/issues/1
Issue URL: https://github.com/hummbl-io/docs/issues/1
Issue title: docs: replace Mintlify starter README with HUMMBL docs source-of-record
Last issue update: 2026-06-28T03:11:09Z
Labels: cluster/repo-hygiene, priority/P2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Status: draft PR promotion
Source issue: #2
Issue URL: https://github.com/hummbl-dev/docs/issues/2
Issue URL: https://github.com/hummbl-io/docs/issues/2
Issue title: evidence: add claim ledger for public compliance and primitive-count docs claims
Last issue update: 2026-06-28T03:11:10Z
Labels: cluster/repo-hygiene, priority/P2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Status: draft PR promotion
Source issue: #3
Issue URL: https://github.com/hummbl-dev/docs/issues/3
Issue URL: https://github.com/hummbl-io/docs/issues/3
Issue title: ci: add Mintlify docs navigation and claim-surface validation
Last issue update: 2026-06-28T03:11:11Z
Labels: cluster/repo-hygiene, priority/P2
Expand Down
2 changes: 1 addition & 1 deletion hummbl.repo.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repo:
name: docs
org: hummbl-dev
org: hummbl-io
description: "HUMMBL documentation and knowledge base"
visibility: public
class: code/library
Expand Down
2 changes: 1 addition & 1 deletion introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Every time your agent runs, all three records are produced automatically. This m

## Governance primitives

Hummbl ships 34 governance primitives across 10 categories. The seven shown below are the most commonly composed user-facing primitives. See the [hummbl-governance](https://github.com/hummbl-dev/hummbl-governance) source for the full inventory.
Hummbl ships 34 governance primitives across 10 categories. The seven shown below are the most commonly composed user-facing primitives. See the [hummbl-governance](https://github.com/hummbl-io/hummbl-governance) source for the full inventory.

<CardGroup cols={2}>
<Card title="Governance Bus" icon="database">
Expand Down
69 changes: 0 additions & 69 deletions sources/docs/github.com/hummbl-agent.md

This file was deleted.

12 changes: 0 additions & 12 deletions sources/docs/github.com/hummbl-agent/hummbl-agent.md

This file was deleted.

52 changes: 0 additions & 52 deletions sources/docs/github.com/hummbl-agent/hummbl-agent/actions.md

This file was deleted.

35 changes: 0 additions & 35 deletions sources/docs/github.com/hummbl-agent/hummbl-agent/community.md

This file was deleted.

12 changes: 0 additions & 12 deletions sources/docs/github.com/hummbl-agent/hummbl-agent/compare.md

This file was deleted.

Loading
Loading