@simpleapps-com/augur-skills 0.0.16 → 0.0.18
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.
package/package.json
CHANGED
|
@@ -25,6 +25,7 @@ If `git push` fails with 401/403, run `gh auth setup-git` to fix credentials.
|
|
|
25
25
|
## Key Topics
|
|
26
26
|
|
|
27
27
|
- **Wiki as context** — See `wiki-as-context.md` for why the wiki is the source of truth and how to write for both humans and AI agents.
|
|
28
|
+
- **Wiki maintenance** — See `wiki-maintenance.md` for how to verify, update, and maintain wiki content correctly.
|
|
28
29
|
- **Project structure** — See `project-structure.md` for the `{project}/[repo|wiki]` layout, what goes where, and wiki conventions.
|
|
29
30
|
- **Issues & pull requests** — See `issues-prs.md` for issue templates, PR commands, and cross-linking with Basecamp.
|
|
30
31
|
|
|
@@ -6,13 +6,13 @@ Every project MUST use this layout:
|
|
|
6
6
|
|
|
7
7
|
```
|
|
8
8
|
{project}/
|
|
9
|
-
├── repo/
|
|
10
|
-
├── wiki/
|
|
11
|
-
├── wip/
|
|
12
|
-
└──
|
|
9
|
+
├── repo/ # Main git repo (simpleapps-com/<name>.git)
|
|
10
|
+
├── wiki/ # GitHub wiki repo (simpleapps-com/<name>.wiki.git)
|
|
11
|
+
├── wip/ # Work-in-progress files for active tasks (not in git)
|
|
12
|
+
└── .simpleapps/ # Project-level secrets and credentials (not in git)
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
The parent `{project}/` directory is NOT a git repo — it's a local wrapper that keeps the code repo and wiki side-by-side. The `wip/` and
|
|
15
|
+
The parent `{project}/` directory is NOT a git repo — it's a local wrapper that keeps the code repo and wiki side-by-side. The `wip/` and `.simpleapps/` directories sit outside both git trees so their contents can never be accidentally committed.
|
|
16
16
|
|
|
17
17
|
## Why This Pattern
|
|
18
18
|
|
|
@@ -41,7 +41,8 @@ If the wiki repo doesn't exist yet, create it by adding any page via the GitHub
|
|
|
41
41
|
| Repo `.claude/rules/` | `repo/` | Minimal summaries referencing wiki pages |
|
|
42
42
|
| Repo `.claude/CLAUDE.md` | `repo/` | Quick reference + wiki links |
|
|
43
43
|
| Active task context | `wip/` | WIP files for Basecamp todos or GitHub issues |
|
|
44
|
-
|
|
|
44
|
+
| Project secrets | `{project}/.simpleapps/` | Site-specific credentials, `{siteId}.json` |
|
|
45
|
+
| Global secrets | `~/.simpleapps/` | Shared credentials across all projects |
|
|
45
46
|
|
|
46
47
|
Rule of thumb: if a `.md` file isn't built into the end product, it belongs in the wiki. If it contains secrets or ephemeral task state, it belongs outside both git trees.
|
|
47
48
|
|
|
@@ -69,15 +70,18 @@ The `wip/` directory holds work-in-progress files that AI agents create when pic
|
|
|
69
70
|
|
|
70
71
|
### What does NOT belong in WIP
|
|
71
72
|
|
|
72
|
-
- Secrets, credentials, or tokens (use
|
|
73
|
+
- Secrets, credentials, or tokens (use `.simpleapps/`)
|
|
73
74
|
- Final documentation (use `wiki/`)
|
|
74
75
|
- Code (use `repo/`)
|
|
75
76
|
|
|
76
|
-
##
|
|
77
|
+
## Credentials (`.simpleapps/`)
|
|
77
78
|
|
|
78
|
-
|
|
79
|
+
Secrets and credentials live in `.simpleapps/` directories at two levels:
|
|
79
80
|
|
|
80
|
-
|
|
81
|
+
- **`~/.simpleapps/`** (user-level) — shared credentials across all projects (e.g., `augur-api.json`, `basecamp.json`)
|
|
82
|
+
- **`{project}/.simpleapps/`** (project-level) — credentials specific to that project (e.g., `{siteId}.json` with test user creds)
|
|
83
|
+
|
|
84
|
+
Project-level credentials override user-level ones when both exist. Both directories sit outside git trees so nothing can be accidentally committed.
|
|
81
85
|
|
|
82
86
|
MUST NOT be committed to any git repository. MUST NOT be copied into `repo/` or `wiki/`.
|
|
83
87
|
|
|
@@ -110,24 +110,23 @@ This matters for two reasons:
|
|
|
110
110
|
- **Devs** jump straight to the answer instead of scrolling through a page
|
|
111
111
|
- **AI agents** use anchor links as an attention signal — a `#section` reference tells the agent exactly which part of a page is relevant to the current task, reducing noise in a 20K token wiki
|
|
112
112
|
|
|
113
|
-
###
|
|
113
|
+
### Keep It Lean
|
|
114
114
|
|
|
115
|
-
The
|
|
115
|
+
Wikis SHOULD be as small as possible while remaining complete. The goal: an AI agent can load the **entire wiki** into context at session start and keep it there throughout.
|
|
116
116
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
If the wiki approaches the budget:
|
|
117
|
+
Guidelines:
|
|
120
118
|
- Tighten language — cut filler, use tables over prose
|
|
121
119
|
- Merge overlapping pages
|
|
122
|
-
-
|
|
120
|
+
- Document patterns and principles, not exhaustive implementation details (see `wiki-maintenance.md`)
|
|
123
121
|
- Archive obsolete pages (delete, don't hoard)
|
|
122
|
+
- Move implementation specifics back to code comments where they belong
|
|
124
123
|
|
|
125
|
-
To check
|
|
124
|
+
To check wiki size:
|
|
126
125
|
```bash
|
|
127
126
|
wc -c {project}/wiki/*.md
|
|
128
127
|
```
|
|
129
128
|
|
|
130
|
-
Rough conversion: 1 token ≈ 3 bytes of markdown.
|
|
129
|
+
Rough conversion: 1 token ≈ 3 bytes of markdown.
|
|
131
130
|
|
|
132
131
|
### Right-Size Each Page
|
|
133
132
|
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Wiki Maintenance
|
|
2
|
+
|
|
3
|
+
Guidance for agents editing wiki content. Applies to all `wiki/*.md` files across all projects.
|
|
4
|
+
|
|
5
|
+
## Verify Before You Write
|
|
6
|
+
|
|
7
|
+
Cross-check wiki claims against the codebase before updating. Staleness-prone sections:
|
|
8
|
+
|
|
9
|
+
- Package versions (`package.json` is the source of truth)
|
|
10
|
+
- File counts and file inventories (files get added/deleted)
|
|
11
|
+
- CI/CD workflow status (workflows get added/modified)
|
|
12
|
+
- TODO items and "not yet built" markers (things get done)
|
|
13
|
+
- Export lists and API surfaces (code changes)
|
|
14
|
+
|
|
15
|
+
**Never echo what the wiki already says.** Read the code, then write the wiki.
|
|
16
|
+
|
|
17
|
+
## Patterns, Not Details
|
|
18
|
+
|
|
19
|
+
The wiki documents **conventions and principles**. The code is the source of truth for specifics.
|
|
20
|
+
|
|
21
|
+
- No hardcoded counts ("22 components", "14 hooks" — these change)
|
|
22
|
+
- No exhaustive lists of every type, hook, component, or export by name
|
|
23
|
+
- No pinned version numbers for peer dependencies
|
|
24
|
+
- Instead: describe the pattern, give 1-2 examples, point to source code for the current list
|
|
25
|
+
|
|
26
|
+
## Naming Conventions
|
|
27
|
+
|
|
28
|
+
Follow the project's existing convention:
|
|
29
|
+
|
|
30
|
+
- **Site wikis**: PascalCase with hyphens (`Getting-Started.md`, `Architecture.md`)
|
|
31
|
+
- **Package wikis**: Prefix-based sections (`guide-*.md` for users, `design-*.md` for contributors)
|
|
32
|
+
|
|
33
|
+
Check `Home.md` or `_Sidebar.md` to confirm the convention before creating new pages.
|
|
34
|
+
|
|
35
|
+
## Keep Indexes Current
|
|
36
|
+
|
|
37
|
+
When adding or removing pages, MUST update:
|
|
38
|
+
|
|
39
|
+
- `Home.md` / `README.md` (index tables)
|
|
40
|
+
- `_Sidebar.md` (navigation)
|
|
41
|
+
- `llms.txt` (if present)
|
|
42
|
+
|
|
43
|
+
## Tagging for Lead-Site Wikis
|
|
44
|
+
|
|
45
|
+
The lead site wiki (e.g., ampro-online) serves as both site documentation and platform reference. Tag sections:
|
|
46
|
+
|
|
47
|
+
- **(platform pattern)** — guidance all sites SHOULD follow
|
|
48
|
+
- **(site-specific)** — this site's particular values, replace with your own
|
|
49
|
+
|
|
50
|
+
This tells agents working on other sites what to replicate vs customize.
|
|
51
|
+
|
|
52
|
+
## Dual-Audience Framing
|
|
53
|
+
|
|
54
|
+
Lead site wikis serve two audiences:
|
|
55
|
+
|
|
56
|
+
1. Developers/agents working on **that site**
|
|
57
|
+
2. Developers/agents building or migrating **other sites**
|
|
58
|
+
|
|
59
|
+
Write for both: document current reality AND provide guidance others can follow.
|
|
60
|
+
|
|
61
|
+
## Git Workflow
|
|
62
|
+
|
|
63
|
+
The wiki is a separate git repo at `wiki/`. No branch protection, no PRs, no changesets.
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
git -C wiki add -A
|
|
67
|
+
git -C wiki commit -m "docs: describe the change"
|
|
68
|
+
git -C wiki push
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Wiki repos typically use `master` as the default branch.
|