Skip to content

Commit b97b0f0

Browse files
author
CID Agent
committed
Sync docs Available Bindings table with README
Add missing Ruby and C#/.NET entries, update Java to Maven Central, update C/C++ to GitHub Releases. Fix stale Java Quick Start tab. Add bindings table consistency requirement to documentation spec.
1 parent d14bf95 commit b97b0f0

File tree

2 files changed

+28
-13
lines changed

2 files changed

+28
-13
lines changed

.claude/context/specs/documentation.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,14 @@ example are included. The landing page quick start and all how-to guides use thi
6565

6666
`docs/CNAME` contains `lib.iscc.codes`.
6767

68+
## Bindings Table Consistency
69+
70+
The "Available Bindings" table in `docs/index.md` and the Quick Start tabbed examples MUST stay in
71+
sync with the README's Installation section. Whenever a new binding is released or an install method
72+
changes (e.g., a package graduates from "build from source" to a published registry), both the
73+
README and the docs landing page must be updated together. The README is the source of truth — the
74+
docs table must list the same set of languages, registry links, and install commands.
75+
6876
## Verification Criteria
6977

7078
- [ ] `uv run zensical build` succeeds
@@ -81,3 +89,5 @@ example are included. The landing page quick start and all how-to guides use thi
8189
- [ ] Abbreviations expand on hover
8290
- [ ] `docs/CNAME` contains `lib.iscc.codes`
8391
- [ ] Docs workflow generates `llms-full.txt` during build
92+
- [ ] "Available Bindings" table lists all languages from README (Rust, Python, Node.js, Java, Go,
93+
Ruby, C#/.NET, C/C++, WASM) with correct registry links and install commands

docs/index.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ decentralized, content-based identification without a central registry.
2626
- **Complete ISO 24138 coverage** — all 10 `gen_*_v0` functions implemented
2727
- **Full conformance** — passes all official test vectors from iscc-core
2828
- **High performance** — pure Rust core delivers significant speedups over the Python reference
29-
- **Multi-language** — use from Rust, Python, Java, Go, Node.js, WebAssembly, or C
29+
- **Multi-language** — use from Rust, Python, Java, Go, Ruby, C#, C++, Node.js, WebAssembly, or C
3030
- **Cross-platform** — runs on Linux, macOS, and Windows
3131

3232
## Supported Code Types
@@ -89,9 +89,12 @@ decentralized, content-based identification without a central registry.
8989

9090
=== "Java"
9191

92-
```bash
93-
# Build from source (Maven Central not yet available)
94-
cargo build -p iscc-jni --release
92+
```xml
93+
<dependency>
94+
<groupId>io.iscc</groupId>
95+
<artifactId>iscc-lib</artifactId>
96+
<version>0.3.1</version>
97+
</dependency>
9598
```
9699

97100
```java
@@ -132,15 +135,17 @@ decentralized, content-based identification without a central registry.
132135

133136
## Available Bindings
134137

135-
| Platform | Package | Install |
136-
| ----------- | ----------------------------------------------- | --------------------------------------------- |
137-
| Rust | [crates.io](https://crates.io/crates/iscc-lib) | `cargo add iscc-lib` |
138-
| Python | [PyPI](https://pypi.org/project/iscc-lib/) | `pip install iscc-lib` |
139-
| Node.js | [npm](https://www.npmjs.com/package/@iscc/lib) | `npm install @iscc/lib` |
140-
| Java | Maven Central (planned) | Build from source (`cargo build -p iscc-jni`) |
141-
| Go | Go module | `go get github.com/iscc/iscc-lib/packages/go` |
142-
| WebAssembly | [npm](https://www.npmjs.com/package/@iscc/wasm) | `npm install @iscc/wasm` |
143-
| C / C++ | Source | Via C FFI header (`iscc.h`) |
138+
| Platform | Package | Install |
139+
| ----------- | ----------------------------------------------------------------------- | --------------------------------------------- |
140+
| Rust | [crates.io](https://crates.io/crates/iscc-lib) | `cargo add iscc-lib` |
141+
| Python | [PyPI](https://pypi.org/project/iscc-lib/) | `pip install iscc-lib` |
142+
| Node.js | [npm](https://www.npmjs.com/package/@iscc/lib) | `npm install @iscc/lib` |
143+
| Java | [Maven Central](https://central.sonatype.com/artifact/io.iscc/iscc-lib) | See Quick Start above |
144+
| Go | [Go module](https://pkg.go.dev/github.com/iscc/iscc-lib/packages/go) | `go get github.com/iscc/iscc-lib/packages/go` |
145+
| Ruby | [RubyGems](https://rubygems.org/gems/iscc-lib) | `gem install iscc-lib` |
146+
| C# / .NET | [NuGet](https://www.nuget.org/packages/Iscc.Lib) | `dotnet add package Iscc.Lib` |
147+
| C / C++ | [GitHub Releases](https://github.com/iscc/iscc-lib/releases) | Pre-built tarballs per platform |
148+
| WebAssembly | [npm](https://www.npmjs.com/package/@iscc/wasm) | `npm install @iscc/wasm` |
144149

145150
## Links
146151

0 commit comments

Comments
 (0)