Skip to content

Commit 3600db8

Browse files
UnbreakableMJclaude
andcommitted
fix(spacecraft-document-format): trim description under the 1024-char SKILL limit; document the rule
The Texinfo-first rewrite pushed the frontmatter description to 1058 chars, which the skill loader rejects (hard limit 1024). Trimmed to 966 (58-char margin) with every load-bearing fact intact, and rebuilt both bundles. Also document the limit so it doesn't recur: - new committed AGENTS.md — tool-agnostic digest of the rules that bite, led by the description ≤1024 rule, pointing to CLAUDE.md for the full workflow. - (CLAUDE.md, gitignored/local, also gains the rule + a folded-aware check.) A repo-wide sweep confirms all 19 skills are now under the limit; gnu-coding-standards (1003) and spacecraft-guile-guidelines (1001) sit close, so the rule flags them for any future description edit. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent bd67ac5 commit 3600db8

4 files changed

Lines changed: 39 additions & 14 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md — Construct skill catalogue
2+
3+
Tool-agnostic guidance for any agent (Claude, Codex, Gemini, Grok, …) editing
4+
skills in this repo. The full, detailed workflow lives in `CLAUDE.md` (local,
5+
gitignored); this file is the committed digest of the rules that bite.
6+
7+
## Hard rules
8+
9+
- **`SKILL.md` frontmatter `description` ≤ 1024 characters.** The loader rejects
10+
any skill over the limit (`field 'description' in SKILL.md must be at most
11+
1024 characters`). Folded `description: >` blocks render by joining lines with
12+
spaces (blank lines → newlines, plus a trailing newline); that *rendered*
13+
length is what counts, not the raw line count. Keep a margin — target ≤ 1000.
14+
Some descriptions already run close, so re-check after any description edit.
15+
- **Rebuild BOTH bundles after any skill-dir edit**, in the same commit:
16+
`<name>.zip` (`zip -qr`, keeps dir entries) and `<name>.skill` (`zip -qrD`,
17+
drops them). A bundle that lags its `SKILL.md`/`references/` ships broken
18+
content to every consumer.
19+
- **Stage explicitly by name — never `git add -A` / `git add .`.** Other root
20+
`.skill` files carry unrelated uncommitted changes that must not be swept in.
21+
- **Commit in UTC, signed** (signing is global, no flag needed); assistant
22+
commits add a `Co-Authored-By: Claude …` trailer.
23+
- **Keep the README §2 catalogue row in sync** when adding, removing, or
24+
re-scoping a skill.
25+
26+
See `CLAUDE.md` for the bundling commands, the drift sweep, the push procedure,
27+
and the Home Manager local fan-out.

spacecraft-document-format.skill

-5 Bytes
Binary file not shown.

spacecraft-document-format.zip

-5 Bytes
Binary file not shown.

spacecraft-document-format/SKILL.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
22
name: spacecraft-document-format
33
description: >
4-
Authoring rules for Spacecraft Software documents. Texinfo is the canonical
5-
format for prose documents (manuals, references, guides, reports, books) — a
6-
single `.texi` source compiles to plain text/Info, HTML, and PDF, and converts
7-
to GFM Markdown, so structure and brand are defined once and every output
8-
stays in sync (Standard §8). ODF (.odt) is the secondary prose format and the
9-
primary format for spreadsheets (.ods) and presentations (.odp), which Texinfo
10-
cannot represent. Microsoft Office (.docx/.xlsx/.pptx) is the proprietary
11-
last-resort, used only when a consumer explicitly requires an MS-native file.
12-
Every binary ODF/MS-Office deliverable MUST ship a same-named GFM Markdown
13-
(.md) companion; Texinfo is exempt since the .texi is already plain text. PDF
14-
is always an export (texi2pdf, or LibreOffice headless), never hand-authored.
15-
Documents default to the CC-BY-SA-4.0 document license (GFDL-1.3-or-later
16-
permitted for Texinfo manuals). All rich-text outputs apply Void Navy
17-
(#000027) background and the Standard §11 palette + §12 typography.
4+
Authoring rules for Spacecraft Software documents. Texinfo is canonical for prose
5+
(manuals, references, guides, reports, books): one .texi source compiles to plain
6+
text/Info, HTML, and PDF and converts to GFM Markdown, so structure and brand are
7+
defined once (Standard §8). ODF (.odt) is the secondary prose format and the primary
8+
format for spreadsheets (.ods) and presentations (.odp), which Texinfo cannot represent.
9+
Microsoft Office (.docx/.xlsx/.pptx) is the proprietary last resort, only when a consumer
10+
requires an MS-native file. Every binary ODF/MS-Office deliverable MUST ship a same-named
11+
GFM Markdown (.md) companion; Texinfo is exempt (the .texi is already plain text). PDF is
12+
always an export (texi2pdf, or LibreOffice headless), never hand-authored. Documents
13+
default to the CC-BY-SA-4.0 document license (GFDL-1.3-or-later permitted for Texinfo
14+
manuals). All rich-text outputs apply Void Navy (#000027) and the Standard §11 palette +
15+
§12 typography.
1816
license: GPL-3.0-or-later
1917
maintainer: Mohamed Hammad <Mohamed.Hammad@SpacecraftSoftware.org>
2018
website: https://Construct.SpacecraftSoftware.org/

0 commit comments

Comments
 (0)