Skip to content

Docs Updates #3 - Cleanup "Product" Language#668

Open
bryantgillespie wants to merge 9 commits into
bry/dockem-2a-backfill-idsfrom
bry/dockem-3-language-cleanup
Open

Docs Updates #3 - Cleanup "Product" Language#668
bryantgillespie wants to merge 9 commits into
bry/dockem-2a-backfill-idsfrom
bry/dockem-3-language-cleanup

Conversation

@bryantgillespie
Copy link
Copy Markdown
Member

@bryantgillespie bryantgillespie commented Apr 30, 2026

This PR cleans up the product framing we originally had. We invented product names like Directus Connect and Directus Automate that do not really line up with any of the modules or features inside Directus. This PR attempts to rectify that and clean up the language to be easier for developers to understand.


This pull request refines terminology and navigation throughout the documentation and UI, focusing on clarity and consistency, especially regarding the naming of key pages and features. It replaces terms like "editor" and "explorer" with "item page" and "collection page," respectively, and updates product and feature labels for improved user understanding. Additionally, it enhances the product link component and updates documentation to reflect these changes.

Terminology and Navigation Updates:

  • Replaced references to "editor" with "item page" and "explorer" with "collection page" in guides and documentation, ensuring consistent terminology for single-item and multi-item views. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]

  • Updated navigation and sidebar labels in app.config.ts to use more descriptive and user-friendly terms (e.g., "Guide" instead of "Guides", "APIs" instead of "Connect", "Flows" instead of "Automate", "Deploy" instead of "Manage"). [1] [2] [3] [4]

Product Link and Label Improvements:

  • Enhanced the ProductLink.vue component to display custom labels for certain products (e.g., "Flows", "APIs", "Data Model"), improving clarity in UI elements.

Documentation and Content Updates:

  • Revised introductory and feature descriptions to better reflect the platform's capabilities, emphasizing APIs, SDK, realtime, auth, file management, automations, and the web app. [1] [2] [3] [4] [5] [6]
  • Updated examples and references in the documentation to use the new feature and product names (e.g., "Directus Flows" instead of "Directus Automate"). [1] [2]

These changes collectively improve the consistency, clarity, and usability of both the documentation and the user interface.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 14, 2026 4:04pm

Request Review

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR cleans up the product framing across the docs and UI, removing invented product names like "Directus Connect" and "Directus Automate" that didn't align with actual Directus modules/features. Pages, navigation, and tutorial copy are renamed to use clearer developer-facing terms (e.g., "APIs", "Flows", "item page", "collection page"), and the ProductLink component is updated to render custom labels for renamed products.

Changes:

  • Replace "Directus Automate" with "Directus Flows" and "Directus Connect" with "Directus APIs" throughout tutorials and guides.
  • Rename "editor" → "item page" and "explorer/explore" → "collection page" in guide titles, descriptions, and prose; remove the now-unused editor/explore entries from ProductLink and add a labelMap for custom labels.
  • Update top-level navigation (app.config.ts, nuxt.config.ts) and section navigation files (.navigation.yml) with the new labels, and refresh the homepage product cards/descriptions.

Reviewed changes

Copilot reviewed 40 out of 42 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
app/app.config.ts Update top-nav labels (Guide, APIs, Flows, Deploy).
app/components/content/ProductLink.vue Add labelMap for custom product labels; drop removed products.
nuxt.config.ts Rename sidebar groups "Connect"→"APIs" and "Automate"→"Flows".
content/index.md, content/_partials/engine-studio-box.md Re-title and re-describe the two product cards; remove editor/explore product links.
content/getting-started/1.overview.md, 7.create-an-automation.md Reword intro and rename "Create an Automation" → "Create a Flow".
content/community/2.contribution/2.documentation.md, 3.codebase/1.overview.md Update examples/text to new product names.
content/guides/01.data-model/*.md Replace :product-link{product="editor"} with item page links.
content/guides/02.content/1.explore.md, 2.editor.md Retitle to "Collection Page"/"Item Page" and reword prose.
content/guides/03.auth/2.access-control.md Replace editor product-link with item-page link.
content/guides/04.connect/.navigation.yml, 1.authentication.md Rename "Connect" → "APIs" in nav and description.
content/guides/06.automate/.navigation.yml Add title "Flows" to the automate nav.
content/guides/09.extensions/0.overview.md, 2.api-extensions/3.operations.md, 3.app-extensions/1.interfaces.md, 3.layouts.md Update titles/descriptions to new terminology.
content/guides/12.integrations/6.framer/* Add new Framer integration guide and navigation file.
content/tutorials/2.projects/.md, 3.tips-and-tricks/.md, 5.extensions/.md, 7.workflows/.md Replace "Directus Automate" with "Directus Flows" (and one "Directus Connect" → "Directus APIs") in tutorial titles, descriptions, and body text.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/guides/09.extensions/2.api-extensions/3.operations.md
Comment thread content/tutorials/7.workflows/tag-images-with-clarifai-and-directus-automate.md Outdated
Comment thread content/tutorials/7.workflows/create-github-issues-with-directus-automate.md Outdated
Comment thread content/tutorials/3.tips-and-tricks/importing-files-in-directus-automate.md Outdated
Comment thread nuxt.config.ts
Comment thread app/app.config.ts
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 41 out of 43 changed files in this pull request and generated 1 comment.

---

Operations are single steps in a Flow - the no-code automation tool part of :product-link{product="automate"}.
Operations are single steps in a :product-link{product="automate"} - the no-code automation tool in Directus.
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