diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 012fc4adcc..7004daa35d 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -283,6 +283,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Enhance Your LLM", + "path": "/features/enhance-AI", + "id": "enhance-AI", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Explore Your Workspace", "path": "/features/explore-graph", @@ -399,6 +407,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Enhance Your LLM", + "path": "/features/enhance-AI", + "id": "enhance-AI", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Explore Your Workspace", "path": "/features/explore-graph", diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index 244e61462d..797686fa61 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -383,6 +383,17 @@ "path": "/features/cache-task-results", "tags": ["cache-task-results"] }, + { + "id": "enhance-AI", + "name": "Enhance Your LLM", + "description": "", + "mediaImage": "", + "file": "shared/features/enhance-AI", + "itemList": [], + "isExternal": false, + "path": "/features/enhance-AI", + "tags": ["AI"] + }, { "id": "explore-graph", "name": "Explore Your Workspace", @@ -543,6 +554,17 @@ "path": "/features/cache-task-results", "tags": ["cache-task-results"] }, + "/features/enhance-AI": { + "id": "enhance-AI", + "name": "Enhance Your LLM", + "description": "", + "mediaImage": "", + "file": "shared/features/enhance-AI", + "itemList": [], + "isExternal": false, + "path": "/features/enhance-AI", + "tags": ["AI"] + }, "/features/explore-graph": { "id": "explore-graph", "name": "Explore Your Workspace", diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index d8219e1f33..05d58e74a6 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -257,6 +257,15 @@ "path": "/nx-api/nx/documents/reset" } ], + "AI": [ + { + "description": "", + "file": "shared/features/enhance-AI", + "id": "enhance-AI", + "name": "Enhance Your LLM", + "path": "/features/enhance-AI" + } + ], "explore-graph": [ { "description": "", diff --git a/docs/map.json b/docs/map.json index efda6039e7..c9619c9244 100644 --- a/docs/map.json +++ b/docs/map.json @@ -98,6 +98,12 @@ "tags": ["cache-task-results"], "file": "shared/features/cache-task-results" }, + { + "name": "Enhance Your LLM", + "id": "enhance-AI", + "tags": ["AI"], + "file": "shared/features/enhance-AI" + }, { "name": "Explore Your Workspace", "id": "explore-graph", diff --git a/docs/shared/features/enhance-AI.md b/docs/shared/features/enhance-AI.md new file mode 100644 index 0000000000..a402d11274 --- /dev/null +++ b/docs/shared/features/enhance-AI.md @@ -0,0 +1,69 @@ +# Enhance Your LLM + +{% youtube src="https://youtu.be/RNilYmJJzdk?si=et_6zWMMxJPa7lp2" title="We Just Made Your LLM Way Smarter!" /%} + +Nx's LLM enhancement feature makes your AI assistant significantly smarter by providing it with rich metadata about your workspace structure, project relationships, and architectural decisions. While LLMs are powerful tools for boosting development productivity, their effectiveness depends entirely on the context they have access to. Nx bridges this gap by: + +- Providing **architectural awareness** about your workspace structure and project relationships +- Feeding information about **project ownership and team responsibilities** +- Sharing knowledge about **available tasks** and their configuration +- Including details about **technology stacks** and project types +- Supplying **Nx documentation** context for better assistance + +## How It Works + +![Nx Console LLM Enhancement](/shared/images/nx-enhance-llm-illustration.avif) + +Nx maintains comprehensive metadata about your workspace to power features like [caching](/features/cache-task-results) and [distributed task execution](/ci/features/distribute-task-execution). Nx Console, as an editor extension, hooks into this rich metadata, post-processes it, and feeds it directly to your LLM (currently supporting GitHub Copilot). This enables your LLM to: + +- Understand the complete workspace structure, including applications and libraries +- Know how different projects are connected and their dependency relationships +- Recognize project technology stacks and available tasks +- Access information about project ownership and team responsibilities +- Utilize Nx documentation to provide more accurate assistance + +This enhanced context allows your LLM to move beyond simple file-level operations to understand your workspace at an architectural level, making it a more effective development partner. + +To **enable LLM enhancement in your workspace**: + +1. Install or update [Nx Console](/getting-started/editor-setup) in VS Code +2. Ensure you have GitHub Copilot installed and configured +3. Start using Copilot in your Nx workspace by typing `@nx` at the beginning of your prompt - this will automatically provide the enhanced context + +{% callout type="note" title="Current Support" %} +LLM enhancement is currently available for VS Code with GitHub Copilot. Support for additional editors and LLM providers is planned for future releases. +{% /callout %} + +## Key Benefits + +- **Architectural Understanding** - Your LLM gains deep insight into your workspace structure, identifying applications, libraries, and their relationships. It understands project categorization through tags and can make informed suggestions about feature implementation. + +- **Team and Ownership Awareness** - Access to project ownership information allows the LLM to identify relevant team members for collaboration and provide guidance on who to consult for specific components. + +- **Task and Generator Knowledge** - Enhanced context about workspace tasks and generators enables the LLM to suggest appropriate commands, help set up new projects, and provide guidance on available tasks and their configuration. + +Here are some example queries: + +Ask your LLM about your workspace structure and get detailed, accurate responses: + +![Example of LLM understanding project structure](/blog/images/articles/nx-ai-example-project-data.avif) + +Get informed suggestions about where to implement new functionality based on existing code: + +![Example of LLM providing implementation guidance](/blog/images/articles/nx-ai-example-data-access-feature.avif) + +Identify relevant team members and ownership information: + +![Example of LLM providing ownership information](/blog/images/articles/nx-ai-example-ownership.avif) + +Get assistance with creating new projects using Nx generators: + +![Example of LLM helping with code generation](/blog/images/articles/nx-ai-example-generate-code.avif) + +## Learn More + +For a deeper dive into how Nx's monorepo approach enhances AI capabilities and makes your workspace future-proof, read our blog post [Nx Just Made Your LLM Way Smarter](/blog/nx-just-made-your-llm-smarter). The post explores: + +- How monorepos break down barriers for both teams and LLMs +- Why Nx's metadata is a goldmine for enhancing AI capabilities +- How this positions your workspace for future AI advancements diff --git a/docs/shared/images/nx-enhance-llm-illustration.avif b/docs/shared/images/nx-enhance-llm-illustration.avif new file mode 100644 index 0000000000..b232ce891a Binary files /dev/null and b/docs/shared/images/nx-enhance-llm-illustration.avif differ diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 7899a13075..b01cefd0c1 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -16,6 +16,7 @@ - [Features](/features) - [Run Tasks](/features/run-tasks) - [Cache Task Results](/features/cache-task-results) + - [Enhance Your LLM](/features/enhance-AI) - [Explore Your Workspace](/features/explore-graph) - [Generate Code](/features/generate-code) - [Automate Updating Dependencies](/features/automate-updating-dependencies)