Skip to content

Add CLI multi-file configuration docs#2965

Merged
atharvadeosthale merged 5 commits intomainfrom
docs/cli-multifile-config
May 6, 2026
Merged

Add CLI multi-file configuration docs#2965
atharvadeosthale merged 5 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

Preview deployments create instant URLs for every branch and commit

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

This is a documentation-only PR that adds a "Multi-file configuration" section to the CLI installation page and threads cross-links to it from all affected resource pages (functions, sites, buckets, teams, topics, tables) and product deployment pages.

  • Installation page gains the authoritative multi-file config section covering the includes field, path-resolution semantics, and security constraints on include paths (no parent-directory traversal, no URLs, etc.).
  • Resource pages (buckets, functions, sites, tables, teams, topics) and commands page each get a short paragraph and arrow_link pointing readers to the new section.
  • Changelog entry announces the feature for CLI 20.0.0 but lists a slightly shorter set of supported keys than the installation page (omits databases and collections).

Confidence Score: 5/5

Documentation-only change with no code execution paths affected; safe to merge.

All changes are Markdoc documentation files. The cross-links are internally consistent, the new installation section is well-structured with clear path-security constraints, and no existing content is removed. The only discrepancy is a minor omission of two supported keys in the changelog prose compared to the canonical list on the installation page.

src/routes/changelog/(entries)/2026-05-06.markdoc — the supported-key list is incomplete relative to the installation page.

Important Files Changed

Filename Overview
src/routes/changelog/(entries)/2026-05-06.markdoc New changelog entry for CLI 20.0.0 multi-file config; omits databases and collections from the supported keys list compared to the installation page
src/routes/docs/tooling/command-line/installation/+page.markdoc Adds the authoritative "Multi-file configuration" section with full supported-key list, path resolution rules, and security constraints on include paths
src/routes/docs/tooling/command-line/functions/+page.markdoc Adds cross-link to multi-file configuration with correct note about path resolution relative to the included file
src/routes/docs/tooling/command-line/tables/+page.markdoc Adds cross-link noting both tablesDB and tables arrays can be split
src/routes/docs/tooling/command-line/commands/+page.markdoc Adds a sentence noting which commands support multi-file config and a cross-link to the detailed docs
src/routes/docs/products/functions/deploy-manually/+page.markdoc Adds a cross-link to multi-file configuration for larger projects
src/routes/docs/products/sites/deploy-from-cli/+page.markdoc Adds a cross-link to multi-file configuration and fixes missing trailing newline
src/routes/docs/tooling/command-line/buckets/+page.markdoc Adds cross-link to multi-file configuration and fixes missing trailing newline
src/routes/docs/tooling/command-line/teams/+page.markdoc Adds cross-link to multi-file configuration and fixes missing trailing newline
src/routes/docs/tooling/command-line/topics/+page.markdoc Adds cross-link to multi-file configuration and fixes missing trailing newline

Reviews (4): Last reviewed commit: "remove databases and collections from ch..." | 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
@atharvadeosthale atharvadeosthale merged commit c671cb8 into main May 6, 2026
6 of 7 checks passed
@atharvadeosthale atharvadeosthale deleted the docs/cli-multifile-config branch May 6, 2026 14:38
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.

2 participants