The Card - VVG-web/aurora-studio GitHub Wiki
Wiki home Β· related: Trust Β· Glossary Β· full rules: knowledge rules
A card is one Markdown file in AuroraKnowledgeDB/ that holds the knowledge about one entity β a concept, a
process, a system, a role, a status, a requirement. It is not a summary of a document: five documents about one subject
feed one card, and a side explanation inside a card is moved out into its own card and left as a link.
---
title: "Refund"
aliases: ["Return of payment"]
type: concept
status: draft
kind: knowledge
sources:
- "Sources/Confluence/Payments/Refund.md"
built: machine
created: 2026-09-01
updated: 2026-09-01
related: ["Payment", "Chargeback"]
---
A refund returns money to the payer within ten days of a request. β¦ β the thesis, written by the model
## Source (carried over verbatim)
β¦the original text, moved by a script, never retoldβ¦
## Change history
- 2026-09-01: card created| Part | Meaning |
|---|---|
title, aliases
|
The name and the other names that lead to the card; links use the file name |
type |
The kind of thing, tied to the section folder: Concepts β concept, Processes β process, Glossary β glossary, Systems β system, Roles β role, Statuses β status-model, Reference β reference, Requirements β requirement, Specs β spec, Decisions β decision, Questions β question
|
status |
The trust class β see below. Computed by the engine, not typed by a human |
kind |
Who is allowed to touch the body β see below |
sources |
Where the knowledge came from (a mirror path or a Raw/ file) |
built: machine |
The engine's mark. Its absence means "origin unknown", not "written by a human" |
related, [[links]]
|
The card's links: a card without any is a lint error |
| thesis + "Source" + history | The thesis is a short claim; the verbatim source sits under it; the history footer is never overwritten |
One parser reads the head (aurora_common.frontmatter): a list may be written inline (aliases: ["A", "B"]) or as a block (aliases: with - "A" items below) β the graph, search, embeddings and maps of content see both forms the same way. A blank line or a # β¦ comment inside a block does not close it. The body starts after the closing --- line; a triple dash inside a value (title: "Retro --- results") does not end the head.
kind |
What it is | Who writes the body |
|---|---|---|
dictionary |
A reference list, carried over whole | nobody retells it; the model gives only a name and a summary |
document |
Verbatim text of a document | a script carries it; never rewritten |
knowledge |
An entity the model has understood | the model writes a thesis, the verbatim source goes under it, Momus checks the thesis |
The kind is stronger than the status: a trusted dictionary still must not be retold.
The type (type) is what the card is about and by which template it is made; the kind (kind) answers a
different question β "who edits the body". Every type has a template β a file TemplatesCommon/akdb_<type>_v1.0.md:
the type's passport (name, base section, allowed kinds and statuses, body sections), a head and body skeleton, an
example and a self-check list. It is read by a human, an assistant and the engine itself. There are thirteen types:
| Class | Types |
|---|---|
| entity |
concept, glossary, process, system, role, status-model, requirement
|
| verbatim carrier |
reference, cited-document
|
| record |
decision, question, correction
|
| map | moc |
Unsure which type to choose β take concept; the borders of neighbouring types are worked out in the templates
themselves. The template: field in the head names the file the card was made by (template: akdb_concept_v1.0.md);
older cards do not have it β that is a "pre-template" card, not an error. The list of types and sections is
kb:cards --list, the check is kb:cards --check (and the "card templates" section of kb:lint). For now the check
only advises: it rewrites nothing and forbids nothing. A released template is not edited β a fix comes as a new
version (v1.1).
Project rules. The type is chosen by the instruction "How to determine the card type" β the file
Prompts/KB_classify.md: steps 0β7, the answer in one line type: β¦; template: β¦; section: β¦; why: β¦. The file belongs
to the project: your edit stays, the kit's new version lands next to it as .new; kb:cards --guide prints the text. A
type's title, description and switch are the cards: block of aurora.config.yaml. For now the switch only
advises: the check names the cards of a switched-off type, the classifier rejects such a type, and creating cards
does not look at it. The type catalogue AuroraKnowledgeDB/meta/card_types.md is generated (install,
update --apply, kb:cards --write --apply), manual edits in it are lost. All of this is edited in "Project settings β
Card types". Details β card templates.
status |
Meaning |
|---|---|
knowledge |
A fact: every linked Jira issue is in a trusted status, or the source is a signed document in Raw/
|
draft |
Not yet confirmed β enters context only with a loud header and a stated reason |
placeholder |
A stub: a link names the concept but there is no knowledge yet; excluded from search and context |
index |
Service cards: maps of content and tables |
deprecated |
Replaced; kept for history in _archive/
|
stateDiagram-v2
[*] --> draft: parsed
[*] --> placeholder: a link exists, no card yet
placeholder --> draft: a definition appeared
draft --> knowledge: kb#58;trust β sources trusted
knowledge --> draft: an issue went back to work
knowledge --> deprecated: kb#58;supersede
draft --> deprecated: kb#58;supersede
-
A card is an entity. If you find two cards about one thing,
kb:twins/agent:twinsbring them together β the model decides, not a human. -
Links are mandatory. A card nobody can reach is on disk but not in the base (
kb:links --cards,kb:moc). - The engine does not rewrite what it did not write. Dictionary and document bodies, the history footer and the previous thesis are kept.
-
File names must pass on Windows, macOS and Linux β no
< > : " / \ | ? *, notCON/NUL, up to 255 bytes. The check iskit:doctor; the fix iskb:names. β Windows and macOS
Deeper: knowledge rules Β· one-page summary Β· card templates Β· the path of one card.
This wiki is generated from the wiki/ folder of the repository β edit the pages there, changes made here are overwritten. Β· RU-Home