Skip to content

Commit 61c3182

Browse files
create-glossary script
1 parent ae99cea commit 61c3182

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

scripts/create-glossary

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#!/bin/bash
2+
3+
DIR=$(dirname $0)
4+
PROMPT=$(realpath $DIR/prompts/create-glossary.md)
5+
6+
if [ -n $1 ]; then
7+
cd $1
8+
fi
9+
10+
cat $PROMPT
11+
12+
echo "Invoking droid... this may take some time."
13+
droid exec -f $PROMPT --auto medium

scripts/prompts/create-glossary.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= TASK: create a `glossary.adoc` for Couchbase docs
2+
3+
* Start with `llms.txt`, a hierarchical index of Couchbase docs.
4+
* Descend into any relevant docs pages to gather important keywords and gather a short glossary text for each keyword.
5+
* The glossary text should be as short as a few words for simple entries, or as long as a paragraph (3-6 sentences).
6+
* List all glossary items in a single list with headings for A-Z
7+
8+
= NOTABLE TOPICS
9+
10+
The keywords chosen should be about:
11+
12+
* Couchbase technologies and services
13+
* NoSQL and SQL++ databases
14+
* Important devops, development, and deployment terminology related to Couchbase
15+
* Where relevant to learning or managing Couchbase, more general technical terminology
16+
17+
If in doubt about whether a keyword is notable enough to include, then go ahead and add it.
18+
19+
= OUTPUT: In Asciidoc
20+
21+
Even though these sources are in Markdown, we want the `glossary.adoc` to be output in Asciidoc.
22+
23+
If there's already a `glossary.adoc` file, you are free to overwrite this.

0 commit comments

Comments
 (0)