Docs Updates #3 - Cleanup "Product" Language#668
Open
bryantgillespie wants to merge 9 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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/exploreentries fromProductLinkand add alabelMapfor 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.
| --- | ||
|
|
||
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.tsto 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:
ProductLink.vuecomponent to display custom labels for certain products (e.g., "Flows", "APIs", "Data Model"), improving clarity in UI elements.Documentation and Content Updates:
These changes collectively improve the consistency, clarity, and usability of both the documentation and the user interface.