Skip to content

Commit 8bdb6a1

Browse files
committed
manual cleanup by a human after Codex is done
1 parent f362e25 commit 8bdb6a1

File tree

11 files changed

+100
-191
lines changed

11 files changed

+100
-191
lines changed

.github/workflows/CI-julia-nightly.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

.github/workflows/CI.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ concurrency:
99
group: ${{ github.workflow }}-${{ github.ref }}-${{ (github.ref != 'refs/heads/master' && github.ref != 'refs/heads/main') || github.run_number }}
1010
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
1111

12-
env:
13-
ANYTHINGLLM_API_BASE: https://anythingllm.krastanov.org/api/v1
14-
ANYTHINGLLM_API_KEY: 6CNW0SP-V4D46D9-K84QJ19-VHWGSYT
15-
1612
jobs:
1713
test:
1814
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
@@ -34,6 +30,7 @@ jobs:
3430
- uses: julia-actions/julia-runtest@v1
3531
env:
3632
ANYTHINGLLMDOC_FORCE_DEPLOY: "CI tests"
33+
ANYTHINGLLM_API_KEY: ${{ secrets.ANYTHINGLLM_API_KEY }}
3734

3835
docs:
3936
name: Documentation
@@ -49,4 +46,4 @@ jobs:
4946
env:
5047
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5148
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
52-
ANYTHINGLLMDOC_FORCE_DEPLOY: "CI docs"
49+
ANYTHINGLLM_API_KEY: ${{ secrets.ANYTHINGLLM_API_KEY }}

.typos.toml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +0,0 @@
1-
[default.extend-words]
2-
ket = "ket"
3-
anc = "anc"
4-
ba = "ba"
5-
hom = "hom"
6-
IY = "IY"
7-
mor = "mor"
8-
ois = "ois"
9-
Childs = "Childs"
10-
11-
[type.ipynb]
12-
# It detects false possitives in the base64 encoded images inside notebooks
13-
extend-glob = ["*.ipynb"]
14-
check-file = false

Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
1616
Aqua = "0.8"
1717
Documenter = "1"
1818
HTTP = "1"
19-
JSON = "0.21"
20-
julia = "1.9"
19+
JSON = "1"
20+
julia = "1.12"
2121
Test = "1"
2222

2323
[targets]

README.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
11
# AnythingLLMDocs.jl
22

3-
AnythingLLMDocs.jl uploads your Documenter.jl pages and docstrings to an AnythingLLM instance and injects the public chat widget back into the rendered docs. The widget is placed inside a small, sandboxed iframe to avoid the long-standing `require.js` conflicts inside Documenter.
4-
5-
The current code was written primarily by OpenAI Codex and reviewed in full by Stefan Krastanov.
6-
7-
## Quick start
8-
9-
```julia
10-
using AnythingLLMDocs
11-
12-
doc_modules = [MyPackage]
13-
assets = integrate_anythingllm(
14-
"MyPackage",
15-
doc_modules,
16-
@__DIR__;
17-
repo = "github.com/you/MyPackage.jl.git",
18-
options = EmbedOptions(),
19-
)
20-
```
21-
22-
Then pass `assets` into `Documenter.HTML(assets = assets)` inside `makedocs`. All embed configuration options documented in the [AnythingLLM embed README](https://raw.githubusercontent.com/Mintplex-Labs/anythingllm-embed/refs/heads/main/README.md) are exposed as `String` fields on `EmbedOptions` (no validation is performed). The iframe is only slightly larger than the chat window and defaults to opening the chat on page load with a smaller window size; adjust with `EmbedOptions` or `embed_attributes` as needed.
3+
AnythingLLMDocs.jl uploads your Documenter.jl pages and docstrings to an AnythingLLM instance and injects the public chat widget back into the rendered docs.
234

245
### Hacky iframe note
256

benchmark/.gitignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ AnythingLLMDocs = "333fe5f5-19c9-4863-8caf-c9193e7dba62"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44

55
[sources]
6-
AnythingLLMDocs = {path = ".."}
6+
AnythingLLMDocs = {path = "/home/stefan/Documents/ScratchSpace/quantumjulia/AnythingLLMDocs.jl"}

docs/make.jl

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
1-
push!(LOAD_PATH, "../src/")
2-
31
using Documenter
42
using AnythingLLMDocs
53

6-
ENV["ANYTHINGLLMDOC_FORCE_DEPLOY"] = get(
7-
ENV,
8-
"ANYTHINGLLMDOC_FORCE_DEPLOY",
9-
"AnythingLLMDocs docs build",
10-
)
11-
124
doc_modules = [AnythingLLMDocs]
135

6+
api_base="https://anythingllm.krastanov.org/api/v1"
7+
148
assets = integrate_anythingllm(
159
"AnythingLLMDocs",
1610
doc_modules,
17-
@__DIR__;
11+
@__DIR__,
12+
api_base;
1813
repo = "github.com/QuantumSavory/AnythingLLMDocs.jl.git",
1914
options = EmbedOptions(),
2015
)
@@ -33,8 +28,4 @@ makedocs(
3328
],
3429
)
3530

36-
if !isempty(get(ENV, "DOCUMENTER_KEY", "")) || !isempty(get(ENV, "GITHUB_TOKEN", ""))
37-
deploydocs(repo = "github.com/QuantumSavory/AnythingLLMDocs.jl.git")
38-
else
39-
@info "Skipping deploydocs because no credentials were provided."
40-
end
31+
deploydocs(repo = "github.com/QuantumSavory/AnythingLLMDocs.jl.git")

docs/src/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,19 @@ AnythingLLMDocs.jl resets or creates an AnythingLLM workspace for your package d
88
using AnythingLLMDocs
99

1010
doc_modules = [MyPackage]
11+
api_base="https://anythingllm.krastanov.org/api/v1"
1112
assets = integrate_anythingllm(
1213
"MyPackage",
1314
doc_modules,
14-
@__DIR__;
15+
@__DIR__,
16+
api_base;
1517
repo = "github.com/you/MyPackage.jl.git",
1618
options = EmbedOptions(; greeting = "Docs-aware helper", window_width = "320px"),
1719
)
1820
```
1921

20-
Pass `assets` to `Documenter.HTML(assets = assets)` in `makedocs`. All embed attributes listed in the upstream AnythingLLM embed README are represented as `String` fields in `EmbedOptions` and may also be passed directly through `embed_attributes` without validation. The iframe wrapper is only slightly larger than the chat window and defaults to opening the chat immediately with a smaller footprint.
22+
Pass `assets` to `Documenter.HTML(assets = assets)` in `makedocs`. All embed attributes listed in the upstream AnythingLLM embed README are represented as `String` fields in `EmbedOptions`.
2123

22-
## Deployment toggles
24+
## Environmental Variables
2325

24-
Set `ANYTHINGLLMDOC_FORCE_DEPLOY` to any non-empty value to bypass the deploy check when building docs locally. Configure `ANYTHINGLLM_API_BASE` and `ANYTHINGLLM_API_KEY` to point to your instance; the defaults target `https://anythingllm.krastanov.org/api/v1`.
26+
Set `ANYTHINGLLMDOC_FORCE_DEPLOY` to any non-empty value to bypass the deploy check when building docs locally. Configure the environmental variable `ANYTHINGLLM_API_KEY` if you want to avoid hardcoding API keys in the source code.

0 commit comments

Comments
 (0)