docs

Technical Documentation

These docs are aimed at developers working on or interfacing with NeoWiki.

Key docs:

• Glossary - Definitions of NeoWiki concepts. We use these as Ubiquitous Language (UI, code, docs, etc)
• Parser Functions - Reference for {{#view}}, {{#neowiki_value}}, and {{#cypher_raw}}
• Lua API - Reference for the mw.neowiki Scribunto library
• Schema Format - JSON format for Schema definitions
• Subject Format - JSON format for Subject data
• Graph Model - Neo4j node and relationship structure
• Query API - REST endpoint for read-only Cypher queries against the graph backend
• REST API - The complete /neowiki/v0/* endpoint reference, plus the generated OpenAPI spec served at /rest.php/specs/v0/module/-
• Extending NeoWiki - How other extensions add property types, contribute graph data, and reuse NeoWiki's UI
• Installation & Maintenance - Sysadmin guide to installing and maintaining NeoWiki
• Architecture Decision Records - Numbered, dated architectural decisions
• Planning docs - Work-in-progress exploration and discussion documents

Organising these docs

• Explains a domain idea or model → concepts/
• A precise contract (an API or a data format) → reference/
• A numbered, dated decision → adr/
• Work-in-progress exploration → planning/ (not published to the website)
• Sysadmin install, maintenance, or deployment guide → operations/