llm-docs-builder 0.8.0 → 0.8.2
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/.github/workflows/docker.yml +11 -16
- data/.github/workflows/push.yml +1 -1
- data/CHANGELOG.md +6 -0
- data/Gemfile.lock +1 -1
- data/README.md +19 -0
- data/lib/llm_docs_builder/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 574ebb294e2ebf55146cad9a17120f32aefac4ad22f01c72c35eb6dbb2b8cdf5
|
|
4
|
+
data.tar.gz: d1980a9b4186249f03016a7924376624de8b5cad632aa9a96b77cb089048e229
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 39c8e6ebf9fccfd73be6e7ccff8345a16d869cb27051aceef1efb1f12da6c8fc1906ee5dd5fd5e485511dbf5cf7c28a707c24623451448bfde171213eff5a7ed
|
|
7
|
+
data.tar.gz: cb5f2301ad7d535e917565a9b6f0794596dd0dcf443ae2e43d973a592a7e4cf4c04b0c61c523ba05735f29cb6ce67d1e02a20c876274ba5b313485242df8683d
|
|
@@ -4,30 +4,25 @@ concurrency:
|
|
|
4
4
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
5
5
|
cancel-in-progress: true
|
|
6
6
|
|
|
7
|
-
# Temporarily disabled - only runs on manual trigger
|
|
8
7
|
on:
|
|
8
|
+
push:
|
|
9
|
+
tags:
|
|
10
|
+
- 'v*'
|
|
9
11
|
workflow_dispatch:
|
|
10
12
|
|
|
11
|
-
# Automatic triggers disabled for now:
|
|
12
|
-
# push:
|
|
13
|
-
# branches:
|
|
14
|
-
# - master
|
|
15
|
-
# tags:
|
|
16
|
-
# - 'v*'
|
|
17
|
-
# pull_request:
|
|
18
|
-
# branches:
|
|
19
|
-
# - master
|
|
20
|
-
# schedule:
|
|
21
|
-
# # Rebuild weekly to get latest base image security updates
|
|
22
|
-
# - cron: '0 2 * * 0'
|
|
23
|
-
|
|
24
13
|
permissions:
|
|
25
14
|
contents: read
|
|
26
|
-
packages: write
|
|
27
15
|
|
|
28
16
|
jobs:
|
|
29
17
|
docker:
|
|
18
|
+
if: github.repository_owner == 'mensfeld'
|
|
30
19
|
runs-on: ubuntu-latest
|
|
20
|
+
environment: deployment
|
|
21
|
+
|
|
22
|
+
permissions:
|
|
23
|
+
contents: read
|
|
24
|
+
packages: write
|
|
25
|
+
id-token: write
|
|
31
26
|
steps:
|
|
32
27
|
- name: Checkout
|
|
33
28
|
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
|
@@ -84,7 +79,7 @@ jobs:
|
|
|
84
79
|
- name: Test Docker image
|
|
85
80
|
run: |
|
|
86
81
|
docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} version
|
|
87
|
-
docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} --help
|
|
82
|
+
docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} generate --help
|
|
88
83
|
|
|
89
84
|
docker-success:
|
|
90
85
|
name: Docker Success
|
data/.github/workflows/push.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.8.2 (2025-10-17)
|
|
4
|
+
- [Fix] Fixed Docker workflow test to properly invoke help command (use `generate --help` instead of `--help`).
|
|
5
|
+
|
|
6
|
+
## 0.8.1 (2025-10-17)
|
|
7
|
+
- [Enhancement] Ship the docker container.
|
|
8
|
+
|
|
3
9
|
## 0.8.0 (2025-10-14)
|
|
4
10
|
- [Feature] **RAG Enhancement: Heading Normalization** - Transform headings to include hierarchical context for better RAG retrieval.
|
|
5
11
|
- Adds parent context to H2-H6 headings (e.g., "Configuration / Consumer Settings / auto_offset_reset")
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -29,6 +29,25 @@ docker run mensfeld/llm-docs-builder compare \
|
|
|
29
29
|
--url https://yoursite.com/docs/getting-started.html
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
+
**Example output:**
|
|
33
|
+
```
|
|
34
|
+
============================================================
|
|
35
|
+
Context Window Comparison
|
|
36
|
+
============================================================
|
|
37
|
+
|
|
38
|
+
Human version: 127.4 KB (~32,620 tokens)
|
|
39
|
+
Source: https://karafka.io/docs/Pro-Virtual-Partitions/ (User-Agent: human)
|
|
40
|
+
|
|
41
|
+
AI version: 46.3 KB (~11,854 tokens)
|
|
42
|
+
Source: https://karafka.io/docs/Pro-Virtual-Partitions/ (User-Agent: AI)
|
|
43
|
+
|
|
44
|
+
------------------------------------------------------------
|
|
45
|
+
Reduction: 81.1 KB (64%)
|
|
46
|
+
Token savings: 20,766 tokens (64%)
|
|
47
|
+
Factor: 2.8x smaller
|
|
48
|
+
============================================================
|
|
49
|
+
```
|
|
50
|
+
|
|
32
51
|
### Transform Your Documentation
|
|
33
52
|
|
|
34
53
|
```bash
|