Skip to content

feat(docs): Update Docs #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
omahjoub merged 1 commit into from
Aug 6, 2026
+15 −12
Merged

feat(docs): Update Docs #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Three install paths depending on your stack.
<dependency>
<groupId>qa.fanar</groupId>
<artifactId>fanar-core</artifactId>
<version>0.2.0-SNAPSHOT</version>
<version>0.3.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>qa.fanar</groupId>
<artifactId>fanar-json-jackson3</artifactId> <!-- or fanar-json-jackson2 -->
<version>0.2.0-SNAPSHOT</version>
<version>0.3.0-SNAPSHOT</version>
</dependency>
</dependencies>
```
Expand All @@ -64,7 +64,7 @@ try (FanarClient client = FanarClient.builder().apiKey(System.getenv("FANAR_API_
<dependency>
<groupId>qa.fanar</groupId>
<artifactId>fanar-spring-boot-4-starter</artifactId>
<version>0.2.0-SNAPSHOT</version>
<version>0.3.0-SNAPSHOT</version>
</dependency>
```

Expand All @@ -88,7 +88,7 @@ class MyController {
<dependency>
<groupId>qa.fanar</groupId>
<artifactId>fanar-spring-ai-starter</artifactId>
<version>0.2.0-SNAPSHOT</version>
<version>0.3.0-SNAPSHOT</version>
</dependency>
```

Expand Down
15 changes: 8 additions & 7 deletions docs/PROJECT_STATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@

## Phase

**0.2.0 in flight — 2026-08 spec absorbed on `main`.** The refreshed Fanar OpenAPI spec
(downloaded 2026-08-05; `openapi.json` normative + new `openapi.yaml` twin) is fully modelled:
`Fanar-Sadiq-2` + `persona` + `madhab`, streamed + emotional TTS, rich voice catalogue, image
prompt revision, the 499 `client_closed_request` error, envelope-code error routing, and Spring
AI vendor options. All shipping modules hold the 100 % JaCoCo gate. Pre-1.0; no Maven Central
artifacts yet (0.1.0 shipped 2026-04-28 as a GitHub Release).
**0.2.0 released 2026-08-06** ([v0.2.0](https://github.com/omahjoub/fanar-java/releases/tag/v0.2.0),
GitHub Release, 10 artifacts); `main` is at `0.3.0-SNAPSHOT`. The release delivers full parity
with the 2026-08 Fanar spec (`openapi.json` normative + `openapi.yaml` twin): `Fanar-Sadiq-2` +
`persona` + `madhab`, streamed + emotional TTS, rich voice catalogue, image prompt revision,
the 499 `client_closed_request` error, envelope-code error routing, and Spring AI vendor
options — three documented breaking changes under ADR-019. All shipping modules hold the
100 % JaCoCo gate. Pre-1.0; no Maven Central artifacts yet. Release process:
[docs/RELEASING.md](RELEASING.md).

## Shipped

Expand All @@ -28,7 +30,6 @@ artifacts yet (0.1.0 shipped 2026-04-28 as a GitHub Release).

## Planned

- **0.2.0 release** — Pattern B release-and-bump flow once the spec-parity PRs land on `main`.
- **Maven Central publication** — Sonatype account, GPG signing, release workflow, version-bump policy. (Intro email to the Fanar team sent 2026-05-01; awaiting Sonatype-path pointer.)
- **Spring Boot 3 starter** — `fanar-spring-boot-3-starter` with the Jackson 2 codec; mechanical port of the SB4 starter.
- **LangChain4j adapter** — `fanar-langchain4j` exposing the equivalent of Spring AI's adapters against LangChain4j's `ChatLanguageModel`.
Expand Down
4 changes: 3 additions & 1 deletion docs/RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ git push -u origin bump/$NEXT
### 7 — Post-release

- [ ] Update `docs/PROJECT_STATE.md` (move the release from *Planned*, refresh the snapshot
date) — can ride in the bump-back PR.
date and phase) — can ride in the bump-back PR.
- [ ] Bump the README quick-start version snippets to `$NEXT` (they track `main`'s snapshot
version; they went stale after both 0.1.0 and 0.2.0 — hence this line).
- [ ] Delete the `release/$VERSION` branch (the tag preserves the commit).
- [ ] Optional smoke: clone at the tag and `./mvnw install`, or resolve an attached jar into a
scratch project.
Expand Down
Loading