Skip to content

Add CLI multi-file configuration docs#2965

Open
ChiragAgg5k wants to merge 3 commits intomainfrom
docs/cli-multifile-config
Open

Add CLI multi-file configuration docs#2965
ChiragAgg5k wants to merge 3 commits intomainfrom
docs/cli-multifile-config

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

Summary

  • Document CLI 20.0.0 multi-file project configuration with the new includes field.
  • Add cross-links from relevant CLI resource docs to the multi-file configuration section.
  • Add a changelog entry announcing multi-file configuration support.

Testing

  • Not run; documentation-only change.

@appwrite
Copy link
Copy Markdown

appwrite Bot commented May 5, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Failed Failed View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Global CDN and DDoS protection come free with every Sites deployment

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

  • Adds a new # Multi-file configuration section to the CLI installation page documenting the includes field introduced in CLI 20.0.0, with examples, path-resolution semantics, and a full list of 11 supported resource keys.
  • Adds consistent cross-link paragraphs/arrow-links to every existing CLI resource page (functions, sites, buckets, teams, topics, tables) and to the product-level deploy docs; no CLI resource pages are missing (databases/collections/webhooks/messages have no standalone CLI reference pages in this repo).
  • Adds a changelog entry that correctly enumerates all supported include keys, resolving an earlier inconsistency.

Confidence Score: 5/5

Documentation-only PR with no logic changes; safe to merge.

All content is internally consistent — the changelog, installation page, and per-resource cross-links agree on the supported include keys. Cross-link coverage matches all existing CLI resource pages in the repo. No broken anchors, no incorrect information, and no code changes are included.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/changelog/(entries)/2026-05-05.markdoc New changelog entry for CLI 20.0.0 multi-file configuration; correctly lists all 11 supported include keys (databases, collections, tablesDB now included).
src/routes/docs/tooling/command-line/installation/+page.markdoc Adds the main "Multi-file configuration" section with examples, path-resolution semantics, supported keys list, and security constraints; content is accurate and well-structured.
src/routes/docs/tooling/command-line/functions/+page.markdoc Adds a cross-link to multi-file configuration with a note about path resolution; also fixes a missing trailing newline.
src/routes/docs/tooling/command-line/sites/+page.markdoc Adds a cross-link to multi-file configuration with a path-resolution note; fixes trailing newline.
src/routes/docs/tooling/command-line/tables/+page.markdoc Adds cross-link note for both tablesDB and tables keys, correctly reflecting that this page covers two distinct include keys.
src/routes/docs/tooling/command-line/buckets/+page.markdoc Adds cross-link to multi-file configuration; fixes trailing newline.
src/routes/docs/tooling/command-line/teams/+page.markdoc Adds cross-link to multi-file configuration; fixes trailing newline.
src/routes/docs/tooling/command-line/topics/+page.markdoc Adds cross-link to multi-file configuration; fixes trailing newline.
src/routes/docs/tooling/command-line/commands/+page.markdoc Adds informational paragraph about multi-file support for init/pull/push/run; fixes trailing newline.
src/routes/docs/products/functions/deploy-manually/+page.markdoc Adds a single cross-link sentence for multi-file configuration; no issues.
src/routes/docs/products/sites/deploy-from-cli/+page.markdoc Adds a single cross-link sentence for multi-file configuration and fixes a missing trailing newline.

Reviews (2): Last reviewed commit: "docs: address CLI config review feedback" | Re-trigger Greptile

Comment thread src/routes/docs/tooling/command-line/installation/+page.markdoc Outdated
Comment thread src/routes/changelog/(entries)/2026-05-05.markdoc Outdated
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