Skip to content

Commit c7867a8

Browse files
snapsynapseclaude
andcommitted
Fix GitHub Pages deployment and add Knowledge as Code attribution
Add contents: write permission to the workflow so peaceiris/actions-gh-pages can push to gh-pages branch. Update README with live examples, pattern definition, and creator attribution. Add ATTRIBUTION.md. Update footer link to point to knowledge-as-code.com. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4fb3232 commit c7867a8

4 files changed

Lines changed: 57 additions & 1 deletion

File tree

.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ on:
77
branches: [main]
88
workflow_dispatch:
99

10+
permissions:
11+
contents: write
12+
1013
jobs:
1114
build:
1215
runs-on: ubuntu-latest

ATTRIBUTION.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Attribution
2+
3+
**Knowledge as Code** is a pattern created by [Sam Rogers](https://sam-rogers.com) at [Snap Synapse](https://snapsynapse.com) in 2025.
4+
5+
- Pattern definition: [knowledge-as-code.com](https://knowledge-as-code.com)
6+
- Template repository: [github.com/snapsynapse/knowledge-as-code-template](https://github.com/snapsynapse/knowledge-as-code-template)
7+
- Creator: [Sam Rogers](https://sam-rogers.com)
8+
- Organization: [Snap Synapse](https://snapsynapse.com)
9+
10+
## Using this template
11+
12+
This template is MIT-licensed. You are free to use, modify, and distribute it for any purpose.
13+
14+
If you build a site using this template, the generated footer includes a small attribution link by default. You are not required to keep it, but we appreciate it if you do — it helps others discover the pattern.
15+
16+
## Citing Knowledge as Code
17+
18+
If you write about or reference the Knowledge as Code pattern:
19+
20+
> Knowledge as Code is a pattern created by Sam Rogers / Snap Synapse that applies software engineering practices to knowledge management. https://knowledge-as-code.com
21+
22+
## Related projects
23+
24+
Knowledge as Code is part of a broader ecosystem of open standards and tools:
25+
26+
- [Graceful Boundaries](https://github.com/snapsynapse/graceful-boundaries) — how services communicate limits to AI agents
27+
- [Siteline](https://github.com/snapsynapse/siteline) — AI agent readiness scanner
28+
- [AI Capability Reference](https://airef.snapsynapse.com) — the first Knowledge-as-Code deployment

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
A template for building structured, version-controlled knowledge bases with an ontology-first approach. Edit a config file, add markdown data, get a full HTML site + JSON API.
44

5+
**[Knowledge as Code](https://knowledge-as-code.com)** is a pattern created by [Sam Rogers](https://sam-rogers.com) at [Snap Synapse](https://snapsynapse.com). It applies software engineering practices to knowledge management: plain text, Git-native, zero-dependency, ontology-driven, multi-output from a single source.
6+
7+
## Live Examples
8+
9+
- [AI Capability Reference](https://airef.snapsynapse.com) — AI model capabilities across 12 products
10+
- [AI Regulation Tracker](https://aireg.snapsynapse.com) — global AI regulatory landscape
11+
- [Meeting Standards Reference](https://meetings.snapsynapse.com) — meeting facilitation standards
12+
513
## Quick Start
614

715
1. **Use this template** — click "Use this template" on GitHub, or clone locally
@@ -77,6 +85,23 @@ node scripts/validate.js # Validate cross-references
7785
- **Bespoke static generation** — the build script _is_ the specification
7886
- **GitOps** — Git is the single source of truth
7987

88+
## The Pattern
89+
90+
Knowledge as Code has six defining properties:
91+
92+
1. **Plain text canonical** — knowledge in human-readable, version-controlled files
93+
2. **Self-healing** — automated verification detects when knowledge drifts from reality
94+
3. **Multi-output** — one source produces every format needed (HTML, JSON API, MCP, SEO pages)
95+
4. **Zero-dependency** — no external packages; nothing breaks when you come back in a year
96+
5. **Git-native** — Git is the collaboration layer, audit trail, and deployment trigger
97+
6. **Ontology-driven** — a vendor-neutral taxonomy maps to domain-specific implementations
98+
99+
Read the full pattern definition at [knowledge-as-code.com](https://knowledge-as-code.com).
100+
101+
## Attribution
102+
103+
Knowledge as Code was created by [Sam Rogers](https://sam-rogers.com) / [Snap Synapse](https://snapsynapse.com). See [ATTRIBUTION.md](ATTRIBUTION.md) for details.
104+
80105
## License
81106

82107
MIT

scripts/build.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ function renderFooter(config) {
453453
const repo = config.repo || '#';
454454
return `<footer>
455455
<p>Maintained with <a href="${escapeHTML(repo)}">version control</a>. This is a reference tool, not professional advice.</p>
456-
<p>&copy; ${new Date().getFullYear()} | Built with <a href="https://github.com/snapsynapse/knowledge-as-code-template">Knowledge-as-Code</a></p>
456+
<p>&copy; ${new Date().getFullYear()} | Built with <a href="https://knowledge-as-code.com">Knowledge-as-Code</a>, a pattern created by <a href="https://snapsynapse.com">Snap Synapse</a></p>
457457
</footer>`;
458458
}
459459

0 commit comments

Comments
 (0)