Skip to content

doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links#1456

Merged
NamelsKing merged 1 commit into
tetherto:release-sdk-0.8.2from
NamelsKing:release-sdk-0.8.2
Apr 9, 2026
Merged

doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links#1456
NamelsKing merged 1 commit into
tetherto:release-sdk-0.8.2from
NamelsKing:release-sdk-0.8.2

Conversation

@NamelsKing

Copy link
Copy Markdown
Contributor

Note: be concise and prefer bullet points.

🎯 What problem does this PR solve?

  • The SDK README was verbose with platform-specific installation details, long example lists, and feature descriptions that duplicated the new docs site at docs.qvac.tether.io
  • Documentation links pointed to the old qvac.tether.dev domain and FeatureBase support page

📝 How does it solve it?

  • Rewrites the README with a concise four-step quickstart (create workspace → install → write script → run)
  • Updates all documentation URLs to docs.qvac.tether.io and support link to the Discord channel
  • Moves detailed platform instructions (Expo, Linux), feature lists, and example indexes to the docs site
  • Bumps version to 0.8.2 and generates changelog for the release

@NamelsKing

Copy link
Copy Markdown
Contributor Author

/review

@github-actions

github-actions Bot commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Tier-based Approval Status

**PR Tier:** TIER1

**Current Status:** ✅ APPROVED

**Requirements:**
- 1 Team Member approval ✅ (1/1)
- 1 Team Lead OR Management approval ✅ (1/1)



---
*This comment is automatically updated when reviews change.*

@NamelsKing NamelsKing merged commit 1e43268 into tetherto:release-sdk-0.8.2 Apr 9, 2026
49 of 51 checks passed
yuranich pushed a commit that referenced this pull request Apr 13, 2026
* chore: qvac-sdk v0.8.1 release (#1285)

* fix: freeze sdk deps installs in publish and sdk-pod checks (#1288)

* chore: update changelog (#1295)

* doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links (#1456)

---------

Co-authored-by: Opanin Akuffo <46673050+opaninakuffo@users.noreply.github.com>
opaninakuffo added a commit that referenced this pull request Apr 13, 2026
* chore: qvac-sdk v0.8.1 release (#1285)

* fix: freeze sdk deps installs in publish and sdk-pod checks (#1288)

* chore: update changelog (#1295)

* doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links (#1456)

* chore[skiplog|notask]: sdk v0.8.3 release, changelog (#1537)

* QVAC-16480 fix: fix kv-cache save race condition in tool-calling completions (#1298)

* doc: add npm keywords and llms.txt link to README

* chore: qvac-sdk v0.8.3 release

---------

Co-authored-by: gbl <59838276+gusttav-lang@users.noreply.github.com>

* chore[notask|skiplog]: cherry-pick workflow migration from qvac-devops to oss-actions (#1545)

* chore: migrate npm publish workflows to use npm trust oidc action of qvac-devops (#1362)

* chore: migrate npm publish workflows to use npm trust oidc action

* fix: remove the secret token from the workflows

* fix: permissions on the workflows for npm trust

* refactor: changed the qvac-devops actions to v1.1.8

* refactor: added NPM_TOKEN

* feat: reflect package.json changes on the PR

* chore: migrate qvac-devops to oss-action (#1478)

---------

Co-authored-by: sidj-thr <siddharth.jain@tether.io>

* chore: trigger sdk publish workflow (#1548)

---------

Co-authored-by: Dmytro Medvinskyi <functionsilence@gmail.com>
Co-authored-by: gbl <59838276+gusttav-lang@users.noreply.github.com>
Co-authored-by: sidj-thr <siddharth.jain@tether.io>
Proletter pushed a commit that referenced this pull request May 24, 2026
Proletter pushed a commit that referenced this pull request May 24, 2026
* chore: qvac-sdk v0.8.1 release (#1285)

* fix: freeze sdk deps installs in publish and sdk-pod checks (#1288)

* chore: update changelog (#1295)

* doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links (#1456)

---------

Co-authored-by: Opanin Akuffo <46673050+opaninakuffo@users.noreply.github.com>
Proletter pushed a commit that referenced this pull request May 24, 2026
* chore: qvac-sdk v0.8.1 release (#1285)

* fix: freeze sdk deps installs in publish and sdk-pod checks (#1288)

* chore: update changelog (#1295)

* doc[notask]: rewrite SDK README with streamlined quickstart and updated docs links (#1456)

* chore[skiplog|notask]: sdk v0.8.3 release, changelog (#1537)

* QVAC-16480 fix: fix kv-cache save race condition in tool-calling completions (#1298)

* doc: add npm keywords and llms.txt link to README

* chore: qvac-sdk v0.8.3 release

---------

Co-authored-by: gbl <59838276+gusttav-lang@users.noreply.github.com>

* chore[notask|skiplog]: cherry-pick workflow migration from qvac-devops to oss-actions (#1545)

* chore: migrate npm publish workflows to use npm trust oidc action of qvac-devops (#1362)

* chore: migrate npm publish workflows to use npm trust oidc action

* fix: remove the secret token from the workflows

* fix: permissions on the workflows for npm trust

* refactor: changed the qvac-devops actions to v1.1.8

* refactor: added NPM_TOKEN

* feat: reflect package.json changes on the PR

* chore: migrate qvac-devops to oss-action (#1478)

---------

Co-authored-by: sidj-thr <siddharth.jain@tether.io>

* chore: trigger sdk publish workflow (#1548)

---------

Co-authored-by: Dmytro Medvinskyi <functionsilence@gmail.com>
Co-authored-by: gbl <59838276+gusttav-lang@users.noreply.github.com>
Co-authored-by: sidj-thr <siddharth.jain@tether.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants