From ad1cc773be4ef53e27a15da1de76988e96bbe7ec Mon Sep 17 00:00:00 2001 From: andreatp Date: Wed, 12 Aug 2026 10:36:28 +0200 Subject: [PATCH] Improve documentation content for users and LLMs - Add Maven Central badge to Quick Start and Installation pages - State Java 11 minimum requirement in Quick Start and Installation - Add threading note: Instance and Store are not thread-safe - Separate blog posts from reference docs in llms-full.txt --- docs/docs/getting-started/installation.md | 4 ++++ docs/docs/index.md | 10 ++++++++++ docs/scripts/generate-llm-files.mjs | 7 ++++++- 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index 17e7544b9..21eb77452 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -5,8 +5,12 @@ title: Installation --- # Installation +Endive requires **Java 11** or later. + Add Endive to your project using Maven or Gradle. +[![Maven Central](https://img.shields.io/maven-central/v/run.endive/runtime)](https://central.sonatype.com/artifact/run.endive/runtime) + ## Maven Add the runtime dependency to your `pom.xml`: diff --git a/docs/docs/index.md b/docs/docs/index.md index be8f3ff01..cee002ed6 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,8 +4,14 @@ sidebar_label: Quick Start title: Quick start --- +:::info[Requirements] +Endive requires **Java 11** or later. SIMD support requires Java 21+. +::: + ### Install the dependency +[![Maven Central](https://img.shields.io/maven-central/v/run.endive/runtime)](https://central.sonatype.com/artifact/run.endive/runtime) + To use the runtime, you need to add the `run.endive:runtime` dependency to your dependency management system. @@ -64,6 +70,10 @@ var module = Parser.parse(new File("./factorial.wasm")); Instance instance = Instance.builder(module).build(); ``` +:::note[Threading] +`Instance` and `Store` are not thread-safe. Create separate instances per thread, or synchronize access externally. Memory operations (used by the Wasm threads proposal) are thread-safe. +::: + You can think of the `module` as of inert code, and the `instance` is the run-time representation of that code: a virtual machine ready to execute. diff --git a/docs/scripts/generate-llm-files.mjs b/docs/scripts/generate-llm-files.mjs index ceb639407..f74353be2 100644 --- a/docs/scripts/generate-llm-files.mjs +++ b/docs/scripts/generate-llm-files.mjs @@ -182,9 +182,14 @@ function generateLlmsFullTxt(docEntries, blogEntries) { sections.push(cleanContent(entry.content)); } + if (blogEntries.length > 0) { + sections.push('---', '', '# Blog Posts', '', + '> The following are blog posts, not reference documentation.', ''); + } + for (const entry of blogEntries) { sections.push('---', ''); - sections.push(`## Blog: ${entry.title}`); + sections.push(`## ${entry.title}`); sections.push(''); sections.push(cleanContent(entry.content)); }