asciidoc-pubkit 0.9.0 → 1.0.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +80 -1495
- data/docs/architecture.md +264 -0
- data/docs/configuration.md +48 -0
- data/docs/custom-rules.md +69 -0
- data/docs/development.md +138 -0
- data/docs/document-commands.md +68 -0
- data/docs/english-review-research.md +314 -0
- data/docs/installation.md +134 -0
- data/docs/list-review.md +50 -0
- data/docs/references.md +48 -0
- data/docs/replacements.md +193 -0
- data/docs/review-workflow.md +267 -0
- data/docs/rules-and-coverage.md +158 -0
- data/docs/scoring.md +37 -0
- data/docs/writing.md +24 -0
- data/lib/asciidoc_pubkit.rb +1 -1
- metadata +15 -1
data/docs/writing.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Writing commands
|
|
2
|
+
|
|
3
|
+
`writing criteria` prints the packaged common criteria. `writing prompt` adds
|
|
4
|
+
task instructions around those same criteria. Neither command needs an AsciiDoc
|
|
5
|
+
file, a review session, MeCab, or network access. Both accept `--lang ja` and
|
|
6
|
+
`--output FILE`; output defaults to stdout, and an existing output file is never
|
|
7
|
+
overwritten. The prompt asks the agent to read project instructions and evidence;
|
|
8
|
+
it does not supply source facts or authorize edits. Book-specific voice and
|
|
9
|
+
format still come from the book. The OSS-only prose style profile remains with
|
|
10
|
+
the book workflow, not the shared default.
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
asciidoc-pubkit writing criteria --lang ja
|
|
14
|
+
asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
For example, `--lang en` exits with an unsupported-language error. No English
|
|
18
|
+
review or writing criteria are shipped in 1.0.0.
|
|
19
|
+
|
|
20
|
+
For a small trial, use `examples/book.adoc` as the scan input. Its Japanese
|
|
21
|
+
paragraphs deliberately contain review candidates; its code block must remain
|
|
22
|
+
unchanged.
|
|
23
|
+
|
|
24
|
+
[Back to README](../README.md)
|
data/lib/asciidoc_pubkit.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: asciidoc-pubkit
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- CyberGarage
|
|
@@ -53,6 +53,20 @@ files:
|
|
|
53
53
|
- data/review-rules.ja.yml
|
|
54
54
|
- data/writing/ja/criteria.md
|
|
55
55
|
- data/writing/ja/headings.md
|
|
56
|
+
- docs/architecture.md
|
|
57
|
+
- docs/configuration.md
|
|
58
|
+
- docs/custom-rules.md
|
|
59
|
+
- docs/development.md
|
|
60
|
+
- docs/document-commands.md
|
|
61
|
+
- docs/english-review-research.md
|
|
62
|
+
- docs/installation.md
|
|
63
|
+
- docs/list-review.md
|
|
64
|
+
- docs/references.md
|
|
65
|
+
- docs/replacements.md
|
|
66
|
+
- docs/review-workflow.md
|
|
67
|
+
- docs/rules-and-coverage.md
|
|
68
|
+
- docs/scoring.md
|
|
69
|
+
- docs/writing.md
|
|
56
70
|
- examples/book.adoc
|
|
57
71
|
- examples/replacements.yml
|
|
58
72
|
- exe/asciidoc-pubkit
|