Skip to content

Refresh SDK READMEs and fix broken badges #2078

Closed

Description

@ChiragAgg5k

Tracks PR #2077 and its companion appwrite/appwrite#14613.

Plan

Goal: Make every published SDK README accurate again: working badges, current install steps, snippets that compile against the generated SDKs, and no dead links.

What changes:

  • docs: refresh SDK READMEs and fix broken badges #2077 (this repo): rewrites templates/*/README.md.twig for all SDKs and the agent plugins (android, cli, dart, deno, dotnet, flutter, go, kotlin, node, php, python, react-native, ruby, rust, swift, unity, web, skills, claude-plugin, codex-plugin, cursor-plugin, zed-extension), plus example.php and the Claude/Codex plugin JSON templates. Badges move to static shields (license from spec.info.license.name, X instead of Twitter, SPM shows {{ sdk.version }}), the Travis badge is dropped, and the Swift package URL is HTTPS.
  • appwrite/appwrite#14613: rewrites the injected docs/sdks/*/GETTING_STARTED.md and EXAMPLES.md, adds a CLI cover (public/images/cli.png), and updates app/config/sdks.php (agent skills point at appwrite/skills, .git suffix dropped from static SDK URLs) and src/Appwrite/Platform/Tasks/SDKs.php.

Remaining steps:

  1. Get both PRs reviewed and merged (they are meant to land together).
  2. Regenerate and release the SDKs so the new READMEs reach the published repos and package registries.

Done when:

Activity

  1. self-assigned this
    on Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions