Skip to content

docs: refresh README - #16

Closed
ChiragAgg5k wants to merge 1 commit into
mainfrom
dev
Closed

ChiragAgg5k wants to merge 1 commit into
mainfrom
dev

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

Refreshes the README with the rewritten getting-started guide and corrected badges, links and install steps from appwrite/sdk-generator#2077 and appwrite/appwrite#14613.

README files only. No code, version or changelog changes, so this does not need a release.

@hansi-codes

hansi-codes Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

🔵 Tier A · Mergeable after minor fixes

The documented CI deployment needs an explicit resource selection flag, and the supported language list omits Python.

Rewrites the Appwrite CLI skill from a command catalog into workflow guidance covering project config, authentication, regional endpoints, schema changes, code generation, deployments, and query/output patterns. Adds a 0.3.0 changelog entry describing the update.

Verdict New comments Fixed Still open
✅ Approved 2 0 0
Finding Where
🟡 Select functions explicitly in the CI example skills/appwrite-cli/SKILL.md:55
🟡 Include Python among supported types languages skills/appwrite-cli/SKILL.md:148
Fix with agent prompt
### Issue 1
skills/appwrite-cli/SKILL.md:55
**Select functions explicitly in the CI example**

This CI example still prompts to choose which configured functions to push; `--force` accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add `--all` to push every configured function, or pass `--function-id` for one.

### Issue 2
skills/appwrite-cli/SKILL.md:148
**Include Python among supported `types` languages**

The CLI also accepts `--language python`, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add `Python (`python`)` to the list.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
📂 Walkthrough · 2
File Change
skills/appwrite-cli/SKILL.md Replaces the command reference with practical CLI workflows and guidance for configuration, auth, generation, deployments, and queries.
CHANGELOG.md Adds the 0.3.0 entry for the CLI skill rewrite.

Reviewed d063456 · Details · Comment @hansi-codes review to re-run, or mention @hansi-codes with a question.

@ChiragAgg5k

Copy link
Copy Markdown
Member Author

Opened by mistake from the existing dev branch; a README-only PR replaces it.

@hansi-codes hansi-codes Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Tier A · Looks good to merge. Summary

appwrite push all --all
# Good — CI against a checked-in config
appwrite client --key "$APPWRITE_API_KEY"
appwrite push function --force

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Select functions explicitly in the CI example

This CI example still prompts to choose which configured functions to push; --force accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add --all to push every configured function, or pass --function-id for one.

Prompt To Fix With AI
This is a comment left during a code review.
Path: skills/appwrite-cli/SKILL.md
Line: 55

Comment:
**Select functions explicitly in the CI example**

This CI example still prompts to choose which configured functions to push; `--force` accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add `--all` to push every configured function, or pass `--function-id` for one.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

🟡 Minor · documentation · Reply if this doesn't apply.

| `appwrite teams delete-membership --team-id <ID> --membership-id <ID>` | Remove a member |
| `appwrite teams get-prefs --team-id <ID>` | Get team preferences |
| `appwrite teams update-prefs --team-id <ID>` | Update team preferences |
For another supported language, or when the project deliberately uses the regular SDK directly, use `appwrite types <output-directory>`. It supports TypeScript (`ts`), JavaScript (`js`), PHP (`php`), Kotlin (`kotlin`), Swift (`swift`), Java (`java`), Dart (`dart`), and C# (`cs`). Pass these short values to `--language`; names such as `typescript` and `csharp` are not the command's accepted values. Generated files type row data, but they do **not** type-check raw database/table IDs or `Query` calls:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include Python among supported types languages

The CLI also accepts --language python, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add Python (python) to the list.

Prompt To Fix With AI
This is a comment left during a code review.
Path: skills/appwrite-cli/SKILL.md
Line: 148

Comment:
**Include Python among supported `types` languages**

The CLI also accepts `--language python`, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add `Python (`python`)` to the list.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

🟡 Minor · documentation · Reply if this doesn't apply.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant