waymark-docs 0.1.1 → 0.2.0
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/CHANGELOG.md +7 -0
- package/README.md +29 -17
- package/dist/commands/find.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to Waymark are documented in this file.
|
|
4
4
|
|
|
5
|
+
## [0.2.0](https://github.com/ysfaran/waymark/compare/v0.1.1...v0.2.0) (2026-08-03)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* **cli:** change require-tags shorthand to -T ([#3](https://github.com/ysfaran/waymark/issues/3)) ([70a95f6](https://github.com/ysfaran/waymark/commit/70a95f6f876e4b48040d778d15bc9189c6020646))
|
|
11
|
+
|
|
5
12
|
## [0.1.1](https://github.com/ysfaran/waymark/compare/v0.1.0...v0.1.1) (2026-08-03)
|
|
6
13
|
|
|
7
14
|
|
package/README.md
CHANGED
|
@@ -35,23 +35,19 @@ npm install --save-dev waymark-docs
|
|
|
35
35
|
|
|
36
36
|
## Quick start
|
|
37
37
|
|
|
38
|
-
1. Create a Waymark configuration
|
|
38
|
+
1. **Create a Waymark configuration.**
|
|
39
|
+
|
|
40
|
+
Run `init` in the repository root:
|
|
39
41
|
|
|
40
42
|
```sh
|
|
41
43
|
npx waymark init
|
|
42
44
|
```
|
|
43
45
|
|
|
44
|
-
2. Define
|
|
45
|
-
|
|
46
|
-
```yaml
|
|
47
|
-
# When true, document metadata must be nested under a `waymark` frontmatter key.
|
|
48
|
-
require-namespace: false
|
|
46
|
+
2. **Define searchable metadata.**
|
|
49
47
|
|
|
50
|
-
|
|
51
|
-
ignore:
|
|
52
|
-
- docs/generated/**
|
|
53
|
-
- vendor/**
|
|
48
|
+
Add the document kinds and tags that agents can search:
|
|
54
49
|
|
|
50
|
+
```yaml
|
|
55
51
|
kinds:
|
|
56
52
|
adr: Read to understand past architectural decisions and their constraints
|
|
57
53
|
convention: Read before changing code to follow required repository practices
|
|
@@ -61,11 +57,10 @@ npm install --save-dev waymark-docs
|
|
|
61
57
|
typescript: TypeScript-related documentation
|
|
62
58
|
```
|
|
63
59
|
|
|
64
|
-
|
|
65
|
-
and `**` wildcards. Waymark also honors `.gitignore` automatically.
|
|
60
|
+
3. **Register a document.**
|
|
66
61
|
|
|
67
|
-
|
|
68
|
-
|
|
62
|
+
Add Waymark metadata to a Markdown or MDX file. For example, save this as
|
|
63
|
+
`docs/conventions/typescript.md`:
|
|
69
64
|
|
|
70
65
|
```yaml
|
|
71
66
|
---
|
|
@@ -76,7 +71,9 @@ npm install --save-dev waymark-docs
|
|
|
76
71
|
# TypeScript conventions
|
|
77
72
|
```
|
|
78
73
|
|
|
79
|
-
4. Validate the repository
|
|
74
|
+
4. **Validate the repository.**
|
|
75
|
+
|
|
76
|
+
Check the configuration and discovered documents:
|
|
80
77
|
|
|
81
78
|
```sh
|
|
82
79
|
npx waymark status
|
|
@@ -91,7 +88,9 @@ npm install --save-dev waymark-docs
|
|
|
91
88
|
Tags: 2
|
|
92
89
|
```
|
|
93
90
|
|
|
94
|
-
5. Discover the document
|
|
91
|
+
5. **Discover the document.**
|
|
92
|
+
|
|
93
|
+
Find the registered convention by kind and tag:
|
|
95
94
|
|
|
96
95
|
```sh
|
|
97
96
|
npx waymark find --kinds convention --tags typescript --show description
|
|
@@ -143,6 +142,19 @@ tags:
|
|
|
143
142
|
example-tag: Explain the topic represented by this tag
|
|
144
143
|
```
|
|
145
144
|
|
|
145
|
+
To skip generated or vendored documentation during discovery, add `ignore`
|
|
146
|
+
patterns:
|
|
147
|
+
|
|
148
|
+
```yaml
|
|
149
|
+
# Skip generated or vendored documentation during discovery.
|
|
150
|
+
ignore:
|
|
151
|
+
- docs/generated/**
|
|
152
|
+
- vendor/**
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Ignore patterns are relative to the repository root and support `*`, `?`, and
|
|
156
|
+
`**` wildcards. Waymark also honors `.gitignore` automatically.
|
|
157
|
+
|
|
146
158
|
`init` never overwrites an existing configuration and does not allow a nested
|
|
147
159
|
configuration beneath another Waymark root.
|
|
148
160
|
|
|
@@ -190,7 +202,7 @@ Usage: waymark find [options]
|
|
|
190
202
|
Options:
|
|
191
203
|
-k, --kinds <identifiers> Match any kind (comma-separated, repeatable)
|
|
192
204
|
-t, --tags <identifiers> Match any tag (comma-separated, repeatable)
|
|
193
|
-
-
|
|
205
|
+
-T, --require-tags <identifiers> Require every tag (comma-separated, repeatable)
|
|
194
206
|
-f, --filter <expression> Match a Boolean metadata filter
|
|
195
207
|
-q, --query <text> Match a literal content query
|
|
196
208
|
-s, --show <fields> Show kind, tags, and description
|
package/dist/commands/find.js
CHANGED
|
@@ -7,7 +7,7 @@ export function createFindCommand() {
|
|
|
7
7
|
.description("Discover Waymark Documents")
|
|
8
8
|
.option("-k, --kinds <identifiers>", "Match any Document Kind (comma-separated, repeatable)", collectOptionValue, [])
|
|
9
9
|
.option("-t, --tags <identifiers>", "Match any Document Tag (comma-separated, repeatable)", collectOptionValue, [])
|
|
10
|
-
.option("-
|
|
10
|
+
.option("-T, --require-tags <identifiers>", "Require every Document Tag (comma-separated, repeatable)", collectOptionValue, [])
|
|
11
11
|
.option("-f, --filter <expression>", "Match a Boolean Metadata Filter")
|
|
12
12
|
.option("-q, --query <text>", "Match a literal Content Query")
|
|
13
13
|
.option("-s, --show <fields>", "Show kind, tags, and description (comma-separated)")
|