Skip to content

Stop escaping the README getting started guide in Python and Ruby #2102

Closed

Description

@ChiragAgg5k

Tracks PR #2100.

Plan

Goal: Make the Python and Ruby SDK READMEs render the getting-started guide as real, copyable code instead of HTML-escaped text (', <REGION>, =>), as reported on appwrite/sdk-for-python#165, appwrite/sdk-for-ruby#80 and appwrite/sdk-for-console-python#20.

What changes:

  • templates/python/README.md.twig and templates/ruby/README.md.twig: switch {{ sdk.gettingStarted|raw|trim }} to |trim|raw, so trim no longer drops the safe marking and Twig stops escaping the guide. Every other template already uses |trim|raw.
  • tests/generation/GenerationTest.php: new testReadmeRendersTheGuideVerbatim, which renders a guide with quotes, angle brackets, & and => for every README-producing language and checks README.md (and example/README.md when generated) contains it verbatim.

Remaining steps: the linked PR is the full generator change. Once it ships in a generator release, the regenerated Python, Ruby and console-Python SDK READMEs pick up the fix.

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