Skip to content

Commit 2a1babc

Browse files
committed
docs: add TOPOLOGY.md
1 parent 24b005f commit 2a1babc

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- SPDX-License-Identifier: MPL-2.0 -->
2+
<!-- (PMPL-1.0-or-later preferred; MPL-2.0 required for VS Code marketplace) -->
3+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
4+
# TOPOLOGY.md — vscode-a2ml
5+
6+
## Purpose
7+
8+
VS Code extension providing syntax highlighting, language configuration, and snippets for A2ML (AI-to-Machine Language) files. Enables editor support for `.a2ml` manifests used across RSR repos. Published to the VS Code marketplace (MPL-2.0 required by platform).
9+
10+
## Module Map
11+
12+
```
13+
vscode-a2ml/
14+
├── syntaxes/ # TextMate grammar for A2ML syntax highlighting
15+
├── snippets/ # Code snippets for common A2ML patterns
16+
├── src/ # Extension TypeScript entry point (marketplace req)
17+
├── icons/ # File type icons
18+
├── language-configuration.json # Bracket matching, comment config
19+
├── package.json # VS Code extension manifest
20+
└── docs/ # Extension documentation
21+
```
22+
23+
## Data Flow
24+
25+
```
26+
[.a2ml file opened] ──► [syntaxes/ grammar] ──► [syntax highlighting]
27+
└──► [snippets/] ──► [completions]
28+
└──► [language-config] ──► [bracket/comment behaviour]
29+
```

0 commit comments

Comments
 (0)