braindb-custom-profile

Authoring a BrainDB custom profile

A custom profile lets you (a) shape how the wiki maintainer/writer name and structure pages and (b) feed BrainDB a custom ingestion source — with zero effect on default behaviour when the profile is not active. One env switch turns a profile on; one self-contained folder holds everything it needs.

The committed custom-profiles/hackernews/ folder is a complete, keyless worked example to copy from. custom-profiles/README.md is the short contract; this is the deep how-to.

The model

• One switch: CUSTOM_PROFILE in the repo-root .env names the active profile(s), comma-separated. Unset ⇒ every prompt is byte-identical to the baked-in default and the ingestor supervisor sleeps.
• One folder: custom-profiles/<name>/ holds the profile's prompt fragments, an optional ingestor.py, and an optional .env.

Folder contract

custom-profiles/<name>/
├── wiki_maintainer.add.md      # appended to the maintainer prompt
├── wiki_maintainer.replace.md  # OR replaces it entirely (advanced)
├── wiki_writer.add.md          # appended to the writer prompt
├── wiki_writer.replace.md      # OR replaces it entirely (advanced)
├── ingestor.py                 # optional: a standalone source feeder
├── .env                        # optional: the ingestor's own config/secrets
└── README.md

Targets are wiki_maintainer and wiki_writer. <target>.add.md is appended to the base prompt; <target>.replace.md replaces it. With several active profiles, add fragments are concatenated in CUSTOM_PROFILE order. All files are optional.

What each prompt shapes

• wiki_maintainer decides, per orphan entity: skip / create (with a proposed_name) / attach / consolidate. Shape naming and dedup here (e.g. "name companies by official name; same ticker = same company").
• wiki_writer authors the page body (free markdown). Shape structure here — the sections, a labelled profile block, a dated chronicle.