@entropicwarrior/sdoc 0.1.14 → 0.1.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +14 -0
  2. package/llms.txt +21 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -63,6 +63,20 @@ python3 tools/serve_docs.py docs/
63
63
 
64
64
  Or use the **SDOC: Browse Documents** command from the VS Code Command Palette.
65
65
 
66
+ ## For AI Agents
67
+
68
+ This repo provides an [`llms.txt`](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/llms.txt) file at the repo root for AI agent discovery.
69
+
70
+ Key resources for agents:
71
+
72
+ | Resource | What it gives you |
73
+ |---|---|
74
+ | [`lexica/sdoc-authoring.sdoc`](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/sdoc-authoring.sdoc) | Skill document — drop into context to read/write SDOC immediately |
75
+ | [`lexica/specification.sdoc`](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/specification.sdoc) | Formal spec with EBNF grammar |
76
+ | [`SDOC_GUIDE.md`](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/SDOC_GUIDE.md) | Quick reference in Markdown |
77
+
78
+ All files in `lexica/` are SDOC-format knowledge documents designed for progressive disclosure — read the `@about` scope first (~50 tokens), then scan headings, then load only the section you need.
79
+
66
80
  ## Format at a Glance
67
81
 
68
82
  ```sdoc
package/llms.txt ADDED
@@ -0,0 +1,21 @@
1
+ # SDOC
2
+
3
+ > A plain-text documentation format with explicit brace scoping. Deterministic parsing, surgical section extraction, and 10-50x token savings compared to Markdown. Zero-dependency JavaScript parser, VS Code extension, slide generation, and PDF export.
4
+
5
+ SDOC uses `{ }` braces to define document structure explicitly. Two parsers, same input, same tree — always. AI agents can navigate an SDOC knowledge base in ~200 tokens of discovery, then extract exactly the section they need in ~200-1000 tokens, instead of loading entire files at 5,000-50,000 tokens each.
6
+
7
+ The authoring guide (`sdoc-authoring.sdoc`) is written as an AI agent skill document. Drop it into any agent's context and it can read and write SDOC immediately.
8
+
9
+ ## Docs
10
+
11
+ - [SDOC Authoring Guide](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/sdoc-authoring.sdoc): Skill document — how to write correct SDOC files. Covers document structure, inline formatting, block types (lists, tables, code, blockquotes), mermaid diagrams, and common mistakes. Start here to learn the format.
12
+ - [SDOC Specification](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/specification.sdoc): Formal v0.1 specification with EBNF grammar. Defines syntax for scopes, lists, tables, code blocks, inline formatting, references, and the meta scope.
13
+ - [Why SDOC Over Markdown](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/why-sdoc.sdoc): The case for SDOC — structural problems with Markdown, why explicit scoping solves them, parsing safety as a security property, and the adoption path forward.
14
+ - [Quick Reference (Markdown)](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/SDOC_GUIDE.md): Compact reference guide in Markdown format for quick lookup.
15
+
16
+ ## Optional
17
+
18
+ - [Requirements](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/requirements.sdoc): Why SDOC exists and what it must achieve. Ten abstract requirements (R1-R10) and concrete constraints (C1-C6).
19
+ - [Slide Authoring Guide](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/lexica/slide-authoring.sdoc): How to create HTML slide decks from SDOC files.
20
+ - [Introduction](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/docs/guide/intro.sdoc): Gentle introduction to the format for newcomers.
21
+ - [Syntax Reference](https://raw.githubusercontent.com/entropicwarrior/sdoc/main/docs/reference/syntax.sdoc): Practical syntax reference with examples.
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@entropicwarrior/sdoc",
3
3
  "displayName": "SDOC",
4
4
  "description": "A plain-text documentation format with explicit brace scoping — deterministic parsing, AI-agent efficiency, and 10-50x token savings vs Markdown.",
5
- "version": "0.1.14",
5
+ "version": "0.1.16",
6
6
  "publisher": "entropicwarrior",
7
7
  "license": "MIT",
8
8
  "repository": {