Back to Activepieces

Brain

brain/knowledge/index.md

0.88.31.3 KB
Original Source

Brain

Durable context for this repo. Every folder here is a page in Craftspace, and every page here is a file in the repo, so the team reads the same thing whether they open GitHub or the app.

This page is a spine: one line per Area, pointing at the page that holds it. Hard-to-reverse calls live as Decisions, not here.

Areas

Add one folder per Area that fits what this project actually holds — an engineering project grows different ones than a sales project does. decisions/ is the only one every repo starts with. Replace these examples with your own and keep the shape: bold name, then the one line that says what a reader will find there.

  • Example Area — what this Area covers, and the one gotcha that bites people in it

How a page is shaped

One Area owns exactly one page, and that page is a glossary spine: one line per term, defining what the term IS. A term that outgrows its line graduates to its own file beside the page. Search before you write — a second page for an Area that already has one is the failure this structure exists to prevent.

Gotchas

  • Craftspace mirrors this folder read-only. Edit the files here and merge, and the pages follow.
  • <area>/index.md is the page for <area>; a file beside it is that page's child.