Skip to content

Commit

Permalink
Update docs (#13)
Browse files Browse the repository at this point in the history 
* Update README.md

* Update index.md
  • Loading branch information
@splendidbug
splendidbug authored Aug 24, 2024
1 parent 5e556f3 commit 98b672d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")

## Building the Index
```julia
using DocsScraper
crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]

index_path = make_knowledge_packs(crawlable_urls;
Expand Down Expand Up @@ -120,4 +121,4 @@ index_name\
```
- Index\: contains the .hdf5 and .tar.gz files along with the artifact__info.txt. Artifact info contains sha256 and git-tree-sha1 hashes. 
- Scraped_files\: contains the scraped chunks and sources. These are separated by the hostnames of the URLs.
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
3 changes: 2 additions & 1 deletion docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")

## Building the Index
```julia
using DocsScraper
crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]

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

2 comments on commit 98b672d

@splendidbug
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/113794

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 98b672d51261152bd30c4acc9dc1c57d8fe81a43
git push origin v0.1.0

Please sign in to comment.