Skip to content

Commit 98b672d

Browse files
authored
Update docs (#13)
* Update README.md * Update index.md
1 parent 5e556f3 commit 98b672d

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")
3232

3333
## Building the Index
3434
```julia
35+
using DocsScraper
3536
crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]
3637

3738
index_path = make_knowledge_packs(crawlable_urls;
@@ -120,4 +121,4 @@ index_name\
120121
```
121122
- Index\: contains the .hdf5 and .tar.gz files along with the artifact__info.txt. Artifact info contains sha256 and git-tree-sha1 hashes. 
122123
- Scraped_files\: contains the scraped chunks and sources. These are separated by the hostnames of the URLs.
123-
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
124+
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.

docs/src/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")
3030

3131
## Building the Index
3232
```julia
33+
using DocsScraper
3334
crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]
3435

3536
index_path = make_knowledge_packs(crawlable_urls;
@@ -117,4 +118,4 @@ index_name\
117118
```
118119
- Index\: contains the .hdf5 and .tar.gz files along with the artifact__info.txt. Artifact info contains sha256 and git-tree-sha1 hashes. 
119120
- Scraped_files\: contains the scraped chunks and sources. These are separated by the hostnames of the URLs.
120-
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
121+
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.

0 commit comments

Comments
 (0)