docs Convert README to Org mode

Use Org mode for the repo README, to match the Org-based content the repo hosts.

Commit
9a4c5c8ea7939a3596c7f64635c07025df6b76e9
Author
Marius Peter <dev@marius-peter.com>
Author date
Committer
Marius Peter <dev@marius-peter.com>
Committer date
Changed files
README.md
index 5f86a619..00000000 100644..000000
@@ -1,93 +0,0 @@
1 Removed: # agent-skills
2 Removed:
3 Removed: A collection of reusable Kiro skills, versioned in one place and shared
4 Removed: across every project.
5 Removed:
6 Removed: ## Layout
7 Removed:
8 Removed: The repo holds two kinds of shareable content. Skills load on demand as
9 Removed: slash commands. Steering modules shape every response.
10 Removed:
11 Removed: ```
12 Removed: agent-skills/
13 Removed: ├── rail/ Skill — Rolling Action Item List
14 Removed: │ ├── SKILL.md
15 Removed: │ ├── rail-tools.el
16 Removed: │ ├── rail-tests.el
17 Removed: │ ├── run-tests.sh
18 Removed: │ └── references/
19 Removed: └── steering/
20 Removed: └── ste100/ Steering — Simplified Technical English
21 Removed: ├── ste100.md
22 Removed: └── references/ ASD-STE100 PDF (supplied locally, not committed)
23 Removed: ```
24 Removed:
25 Removed: ## Install a skill globally
26 Removed:
27 Removed: Kiro loads skills from `~/.kiro/skills/*/SKILL.md` in every project.
28 Removed: Symlink a skill from this repo into that directory. A symlink, not a
29 Removed: copy, so `git pull` in this repo updates every project at once.
30 Removed:
31 Removed: ```sh
32 Removed: ln -s ~/git/agent-skills/rail ~/.kiro/skills/rail
33 Removed: ```
34 Removed:
35 Removed: Confirm the link:
36 Removed:
37 Removed: ```sh
38 Removed: ls -l ~/.kiro/skills/rail
39 Removed: ```
40 Removed:
41 Removed: The global skills directory is package-managed by AIM, but AIM touches
42 Removed: only the skills listed in its `.aim-core-skills.json` manifest. A skill
43 Removed: from this repo is not in that manifest, so AIM leaves it alone.
44 Removed:
45 Removed: ## Install a steering module globally
46 Removed:
47 Removed: Kiro loads steering from `~/.kiro/steering/**/*.md` in every project.
48 Removed: Symlink a steering module the same way:
49 Removed:
50 Removed: ```sh
51 Removed: ln -s ~/git/agent-skills/steering/ste100 ~/.kiro/steering/ste100
52 Removed: ```
53 Removed:
54 Removed: A skill loads on demand. A steering module with `inclusion: always`
55 Removed: shapes every response, with no command.
56 Removed:
57 Removed: ### The STE100 reference PDF
58 Removed:
59 Removed: The `ste100.md` doc points at `ASD-STE100_ISSUE9.pdf`, a paid,
60 Removed: copyrighted standard. The repo does not commit it. To use the full
61 Removed: reference, place your own copy at:
62 Removed:
63 Removed: ```
64 Removed: ~/git/agent-skills/steering/ste100/references/ASD-STE100_ISSUE9.pdf
65 Removed: ```
66 Removed:
67 Removed: The steering rules in `ste100.md` work without the PDF. The PDF only
68 Removed: serves the deep reference lookups that the doc mentions.
69 Removed:
70 Removed: ## Update
71 Removed:
72 Removed: ```sh
73 Removed: cd ~/git/agent-skills && git pull
74 Removed: ```
75 Removed:
76 Removed: Every project that links a skill from this repo picks up the change on
77 Removed: the next session, with no copy step.
78 Removed:
79 Removed: ## Pin one project to an older version
80 Removed:
81 Removed: The symlink shares one version across every project. To pin a single
82 Removed: project, place a copy of the skill under that project's own
83 Removed: `.kiro/skills/<name>/` instead of relying on the global link. A
84 Removed: workspace skill and a global skill of the same name both load, so remove
85 Removed: the global link for that project if you need only the pinned copy.
86 Removed:
87 Removed: ## Test a skill
88 Removed:
89 Removed: Each skill carries its own test runner. For RAIL:
90 Removed:
91 Removed: ```sh
92 Removed: ~/git/agent-skills/rail/run-tests.sh
93 Removed: ```
README.org
index 00000000..98880573 000000..100644
@@ -0,0 +1,94 @@
1 Added: #+TITLE: agent-skills
2 Added: #+OPTIONS: toc:nil
3 Added:
4 Added: A collection of reusable Kiro skills, versioned in one place and shared
5 Added: across every project.
6 Added:
7 Added: * Layout
8 Added:
9 Added: The repo holds two kinds of shareable content. Skills load on demand as
10 Added: slash commands. Steering modules shape every response.
11 Added:
12 Added: #+begin_example
13 Added: agent-skills/
14 Added: ├── rail/ Skill — Rolling Action Item List
15 Added: │ ├── SKILL.md
16 Added: │ ├── rail-tools.el
17 Added: │ ├── rail-tests.el
18 Added: │ ├── run-tests.sh
19 Added: │ └── references/
20 Added: └── steering/
21 Added: └── ste100/ Steering — Simplified Technical English
22 Added: ├── ste100.md
23 Added: └── references/ ASD-STE100 PDF (supplied locally, not committed)
24 Added: #+end_example
25 Added:
26 Added: * Install a skill globally
27 Added:
28 Added: Kiro loads skills from =~/.kiro/skills/*/SKILL.md= in every project.
29 Added: Symlink a skill from this repo into that directory. A symlink, not a
30 Added: copy, so =git pull= in this repo updates every project at once.
31 Added:
32 Added: #+begin_src sh
33 Added: ln -s ~/git/agent-skills/rail ~/.kiro/skills/rail
34 Added: #+end_src
35 Added:
36 Added: Confirm the link:
37 Added:
38 Added: #+begin_src sh
39 Added: ls -l ~/.kiro/skills/rail
40 Added: #+end_src
41 Added:
42 Added: The global skills directory is package-managed by AIM, but AIM touches
43 Added: only the skills listed in its =.aim-core-skills.json= manifest. A skill
44 Added: from this repo is not in that manifest, so AIM leaves it alone.
45 Added:
46 Added: * Install a steering module globally
47 Added:
48 Added: Kiro loads steering from =~/.kiro/steering/**/*.md= in every project.
49 Added: Symlink a steering module the same way:
50 Added:
51 Added: #+begin_src sh
52 Added: ln -s ~/git/agent-skills/steering/ste100 ~/.kiro/steering/ste100
53 Added: #+end_src
54 Added:
55 Added: A skill loads on demand. A steering module with =inclusion: always=
56 Added: shapes every response, with no command.
57 Added:
58 Added: ** The STE100 reference PDF
59 Added:
60 Added: The =ste100.md= doc points at =ASD-STE100_ISSUE9.pdf=, a paid,
61 Added: copyrighted standard. The repo does not commit it. To use the full
62 Added: reference, place your own copy at:
63 Added:
64 Added: #+begin_example
65 Added: ~/git/agent-skills/steering/ste100/references/ASD-STE100_ISSUE9.pdf
66 Added: #+end_example
67 Added:
68 Added: The steering rules in =ste100.md= work without the PDF. The PDF only
69 Added: serves the deep reference lookups that the doc mentions.
70 Added:
71 Added: * Update
72 Added:
73 Added: #+begin_src sh
74 Added: cd ~/git/agent-skills && git pull
75 Added: #+end_src
76 Added:
77 Added: Every project that links a skill from this repo picks up the change on
78 Added: the next session, with no copy step.
79 Added:
80 Added: * Pin one project to an older version
81 Added:
82 Added: The symlink shares one version across every project. To pin a single
83 Added: project, place a copy of the skill under that project's own
84 Added: =.kiro/skills/<name>/= instead of relying on the global link. A
85 Added: workspace skill and a global skill of the same name both load, so remove
86 Added: the global link for that project if you need only the pinned copy.
87 Added:
88 Added: * Test a skill
89 Added:
90 Added: Each skill carries its own test runner. For RAIL:
91 Added:
92 Added: #+begin_src sh
93 Added: ~/git/agent-skills/rail/run-tests.sh
94 Added: #+end_src