Skip to content

Commit 207326b

Browse files
committed
docs: fix doc typos and tiny improvements
1 parent 523a190 commit 207326b

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,23 @@ To check javadocs using the javadoc:javadoc
5555
./mvnw javadoc:javadoc -Pjavadoc
5656
```
5757

58+
## Building the docs locally
59+
60+
You can build and preview the Antora documentation locally without installing anything globally.
61+
62+
Prerequisites:
63+
- Node.js 18+ (20 recommended).
64+
- Download from https://nodejs.org/
65+
66+
Build the site:
67+
68+
```sh
69+
npx -y -p @antora/[email protected] -p @antora/[email protected] antora -r @antora/site-generator antora-playbook.yml
70+
```
71+
72+
Open the generated site:
73+
- `build/site/index.html`
74+
5875
## Contributing
5976

6077
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

jchunk-semantic/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SemanticChunker
22

33
Splits text into chunks based on **semantic similarity** using embeddings.
4-
Instead of relying only on character counts or delimiters, it groups sentences into coherent chunks that better preserve meaning useful for **RAG pipelines**, **semantic search**, and **embedding-based retrieval**.
4+
Instead of relying only on character counts or delimiters, it groups sentences into coherent chunks that better preserve meaning, useful for **RAG pipelines**, **semantic search**, and **embedding-based retrieval**.
55

66
## Installing
77

0 commit comments

Comments
 (0)