Repository navigation
docs: refresh SDK READMEs and fix broken badges - #2077
Merged
Merged
Conversation
State the Python 3.9 floor from requires-python, link the PyPI and RubyGems packages, add Bundler as the primary Ruby install, point the contribution guide at main and trim the getting-started block so no double blank line precedes Contribution.
The Go README's only usage was a 'Testing the SDK' walkthrough built on the legacy Databases documents API with a fake 2021 log line. Getting started now lives in the template because its imports carry the module's major version, which a static GETTING_STARTED.md cannot track. It still yields to sdk.gettingStarted when one is supplied. Rust gains the tokio cargo add step the async SDK needs, and both point the contribution guide at main and trim the injected getting started so the seams render a single blank line.
The package URL rendered as the SSH git remote, which fails for anyone without GitHub SSH keys. Xcode steps used the pre-Xcode 15 menu name, and the README never stated the Swift tools version or minimum platforms from Package.swift.
…ed and push Flutter's minSdk and desugaring requirements apply to every app, not only Push users, so they move under Installation; the Push guide follows Getting Started instead of preceding it and gains a basic subscribe example. Prose is unwrapped, the contribution link points at main, and the getting-started seam no longer renders a double blank line.
Drop the dead s01.oss.sonatype.org snapshot repository (nothing is published there), give Kotlin DSL and Groovy dependency snippets with the minimum Android/Java versions, drop the Maven pom snippet for the Android AAR, move Push after Getting Started with a subscribe example, unwrap hard-wrapped prose, and own the Learn more links with current quick-start and reference URLs.
Show how to use the CDN global and ESM, CommonJS and Deno imports, state the Node.js minimum that undici 6 needs, move the React Native Push guide after getting started and unwrap its prose, trim the injected getting-started block so no blank lines pile up, and point the contribution guide at main.
The Zed extension was rejected from the Zed gallery, so its README pointed at an install path that does not exist; Codex now reads user skills from ~/.agents/skills and installs plugins with codex plugin add; the Claude Code README had no install section at all and its dev commands referenced the generator's examples folder. Cursor and skills READMEs rendered the generic SDK description and a server compatibility warning with a broken releases link, and Claude/Codex hardcoded the Discord badge and labelled the plugin version as an API version.
The Unity manual install pointed at appwrite.io/releases/latest and a .unitypackage that releases never ship, and its contribution link sent readers to the SDK repo on a master branch that does not exist. The .NET install mixed two tools in one PowerShell block, and its TablesDB model notes now live in GETTING_STARTED so they sit before Learn more. Getting started is trimmed so sections are separated by a single blank line.
2 tasks done
🟢 Tier S · Ready to mergeRefreshes the SDK and agent-plugin README templates with current installation instructions, getting-started examples, badges, and links. It also updates plugin homepage metadata and the example license URL, and separates Android background-push guidance into distinct paragraphs. Latest changes: The newest change separates the Android background notification, permission, and foreground-delivery guidance into individual paragraphs without changing their content.
📂 Walkthrough · 18
Reviewed the commits since |
This was referenced Oct 17, 2026
![hansi-codes[bot]](https://avatars.githubusercontent.com/in/5046327?s=60&v=4){kind=small}
This was referenced Oct 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Refreshes every SDK README template. The published READMEs had broken badges, outdated install steps, code that no longer compiles against the generated SDKs, and dead links.
Badges, across all templates:
spec.info.license.name.{{ sdk.version }}.sdk.discordChannel, and their version badge no longer says "api version".Per SDK, the install and getting-started content in the templates was rewritten and every code snippet was compiled or type-checked against freshly generated SDKs (tsc, dart/flutter analyze, Gradle, swift build, go build, cargo check, PHP, dotnet, Python, Ruby). Unity snippets were checked against the generated signatures only.
$prompts removed, shell completion as its own section.dart pub add, Android requirements under installation, push after getting started.s01.oss.sonatype.orgsnapshot repository, Kotlin DSL and Groovy snippets, minSdk 24.git@github.com:...), which fails in Xcode without SSH keys; it is now HTTPS. Requirements come fromPackage.swift.{{ sdk | goPackagePath }}so imports follow the major version.appwrite/skills, install commands match each tool's current CLI, and the Zed README no longer points at an Extension Gallery listing that does not exist.Also: contribution links point at
main, the injected getting-started block is trimmed so no double blank lines appear at the seams, plugin homepages use the current/docs/tooling/ai/agents/*URLs, andexample.phplinks the license onmain.The getting-started content injected into these templates lives in appwrite/appwrite and is updated in a companion PR: appwrite/appwrite#14613
Test Plan
composer lint-twig: 651 files, 0 errorscomposer refactor:check: passesvendor/bin/phpunit --testsuite Generation: 110 tests, 4 skippedGETTING_STARTED.mdinjectedRelated PRs and Issues
Closes #2078