|
| 1 | +;; SPDX-License-Identifier: MIT OR AGPL-3.0-or-later |
| 2 | +;; SPDX-FileCopyrightText: 2025-2026 hyperpolymath |
| 3 | +;; |
| 4 | +;; CANONICAL_README.scm - Pointer to Canonical Documentation |
| 5 | +;; |
| 6 | +;; This file establishes the documentation hierarchy for the repository. |
| 7 | +;; Multiple READMEs exist for different purposes; this file clarifies authority. |
| 8 | + |
| 9 | +(define canonical-docs |
| 10 | + '((schema . "hyperpolymath.canonical-docs/1") |
| 11 | + (updated . "2026-01-01") |
| 12 | + |
| 13 | + ;; ========================================================================== |
| 14 | + ;; PRIMARY DOCUMENTATION |
| 15 | + ;; ========================================================================== |
| 16 | + (primary |
| 17 | + . ((readme |
| 18 | + . ((path . "./README.adoc") |
| 19 | + (purpose . "Main project documentation, quick start, syntax examples") |
| 20 | + (authority . "canonical"))) |
| 21 | + (roadmap |
| 22 | + . ((path . "./ROADMAP.adoc") |
| 23 | + (purpose . "Development phases and milestones") |
| 24 | + (authority . "canonical"))) |
| 25 | + (contributing |
| 26 | + . ((path . "./CONTRIBUTING.adoc") |
| 27 | + (purpose . "How to contribute") |
| 28 | + (authority . "canonical"))) |
| 29 | + (security |
| 30 | + . ((path . "./SECURITY.md") |
| 31 | + (purpose . "Security policy and vulnerability reporting") |
| 32 | + (authority . "canonical"))))) |
| 33 | + |
| 34 | + ;; ========================================================================== |
| 35 | + ;; MACHINE-READABLE DOCUMENTATION |
| 36 | + ;; ========================================================================== |
| 37 | + (machine-readable |
| 38 | + . ((superintendent |
| 39 | + . ((path . "./.machine_read/LLM_SUPERINTENDENT.scm") |
| 40 | + (purpose . "Instructions for AI/LLM agents"))) |
| 41 | + (spec |
| 42 | + . ((path . "./.machine_read/SPEC.core.scm") |
| 43 | + (purpose . "Core language specification (binding)"))) |
| 44 | + (roadmap-f0 |
| 45 | + . ((path . "./.machine_read/ROADMAP.f0.scm") |
| 46 | + (purpose . "Phase f0 scope arrest roadmap"))) |
| 47 | + (state |
| 48 | + . ((path . "./STATE.scm") |
| 49 | + (purpose . "Current project state"))))) |
| 50 | + |
| 51 | + ;; ========================================================================== |
| 52 | + ;; SUPPLEMENTARY DOCUMENTATION (Non-authoritative for Core) |
| 53 | + ;; ========================================================================== |
| 54 | + (supplementary |
| 55 | + . ((academic |
| 56 | + . ((path . "./docs/academic/README.adoc") |
| 57 | + (purpose . "Academic papers and formal proofs") |
| 58 | + (status . "optional"))) |
| 59 | + (implementation |
| 60 | + . ((path . "./docs/IMPLEMENTATION.adoc") |
| 61 | + (purpose . "Implementation details") |
| 62 | + (status . "optional"))))) |
| 63 | + |
| 64 | + ;; ========================================================================== |
| 65 | + ;; EDITOR/TOOLING DOCUMENTATION (OPTIONAL - Does not affect core) |
| 66 | + ;; ========================================================================== |
| 67 | + (optional-tooling |
| 68 | + . ((neovim |
| 69 | + . ((path . "./editors/neovim/README.md") |
| 70 | + (purpose . "Neovim integration") |
| 71 | + (status . "optional - does not block core build"))) |
| 72 | + (helix |
| 73 | + . ((path . "./editors/helix/README.md") |
| 74 | + (purpose . "Helix editor integration") |
| 75 | + (status . "optional - does not block core build"))) |
| 76 | + (tree-sitter |
| 77 | + . ((path . "./tree-sitter-anvomidav/") |
| 78 | + (purpose . "Tree-sitter grammar for syntax highlighting") |
| 79 | + (status . "optional - does not block core build"))))) |
| 80 | + |
| 81 | + ;; ========================================================================== |
| 82 | + ;; READING ORDER FOR NEW CONTRIBUTORS |
| 83 | + ;; ========================================================================== |
| 84 | + (reading-order |
| 85 | + . (("README.adoc" . "Start here for project overview") |
| 86 | + ("ROADMAP.adoc" . "Understand development phases") |
| 87 | + ("CONTRIBUTING.adoc" . "How to participate") |
| 88 | + (".machine_read/SPEC.core.scm" . "Language specification") |
| 89 | + ("crates/anv-cli/src/main.rs" . "CLI entry point"))))) |
0 commit comments