torben
502971d147
Files changed: - .gitea/workflows/ci.yml - .wikitool-kb.json - AGENTS.md - CHANGES.md - INSTALL.md - README.md - VERSION - instructions/CONTRACT.md - instructions/dev/testing-conventions.md - instructions/german-terminology.md - instructions/kb-profiles.md - instructions/migrations/3.0.0-authoring-conventions.md - instructions/private-instance.md - instructions/setup-instance.md - instructions/wiki-ingest/SKILL.md - instructions/wiki-manage/SKILL.md - kb/CONTRACT.md - kb/CONVENTIONS.md - kb/CONVENTIONS.md.template - kb/comparisons/COLLECTION.md - kb/concepts/COLLECTION.md - kb/entities/COLLECTION.md - kb/sources/COLLECTION.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/commands/dist_cmd.py - tools/chemenu/commands/docs_verify.py - tools/chemenu/commands/doctor.py - tools/chemenu/commands/new_page.py - tools/chemenu/conventions.py - tools/chemenu/kb_collections.py - tools/chemenu/kb_scan.py - tools/chemenu/provenance.py - tools/chemenu/sections.py - tools/chemenu/tests/conftest.py - tools/chemenu/tests/test_conventions.py - tools/chemenu/tests/test_dist_cmd.py - tools/chemenu/tests/test_doctor.py - tools/chemenu/tests/test_new_page.py - tools/chemenu/tests/test_types_cmd.py - types/comparison.md - types/concept.md - types/entity.md - types/source.md - types/type-spec.md
2.6 KiB
profile, required_by_stack
| profile | required_by_stack |
|---|---|
| entities | false |
kb/entities/ - Collection Contract
Concrete things that exist: a project, a deployed system, a CLI tool, a technology, a person or an organization. If it can be pointed at, it is an entity.
Quality goal: pointability + currency - a reader should come away knowing what the thing is, where it actually is, and whether that is still true. An entity page that describes a system correctly but names no host, path, version or status has not earned its keep.
Inherits kb/CONTRACT.md for the rules the stack enforces - linking mechanics, provenance, citation, the confidence machinery - and kb/CONVENTIONS.md for what this instance decided: language, naming forms, tone, relationship labels, the confidence rubric. Neither is restated here.
Types offered
entity (tools/wikitool types describe entity). The entity_type: field selects the area:
| Area | Holds |
|---|---|
projects/ |
Codebases and initiatives, named after their repository or common name |
systems/ |
Deployed and running systems, given a descriptive name |
tools/ |
CLI and desktop tools, named as the tool names itself |
technologies/ |
Protocols, languages, formats, in their standard spelling and capitalization |
people/ |
People and organizations, by full name or common handle |
These are areas, not collections: they inherit this contract and carry no COLLECTION.md.
Per-area emphasis
- Projects - purpose, status, language/stack, owner, repository, dependencies on other projects and systems, architectural decisions.
- Systems - purpose, components, dependencies, configuration locations, deployment, operational status, monitoring.
- Technologies - purpose, use cases, trade-offs, version compatibility, which projects and systems use it.
- Tools - purpose, installation, usage, notable options, which projects use it.
- People - role, affiliation, and the projects or decisions they are connected to. Nothing personal beyond what the source states.
Outbound linking
An entity links to the technologies it uses, the systems it runs on, the projects that depend on it, and the concepts it implements.
An entity that mentions a concept without linking it is incomplete; the concept page is where the why lives, and the entity page should not restate it.
What does not belong here
- A pattern, protocol, architecture or decision - those are concepts, even when only one entity uses them.
- A page about a source document - that is a
sourcepage inkb/sources/. - Singular naming is required:
ha-core.md, notha-cores.md.