-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(core): adds feature for LLM enhancing
- Loading branch information
Showing
6 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Enhance Your LLM | ||
|
||
{% youtube src="https://youtu.be/RNilYmJJzdk?si=et_6zWMMxJPa7lp2" title="We Just Made Your LLM Way Smarter!" /%} | ||
|
||
Nx Console'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 Console 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 maintains comprehensive metadata about your workspace to power features like [caching](/features/cache-task-results) and [distributed task execution](/features/distribute-task-execution). Nx Console's LLM enhancement taps into this metadata and preprocesses it before providing it to your LLM (currently supporting GitHub Copilot), enabling it 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: | ||
|
||
 | ||
|
||
Get informed suggestions about where to implement new functionality: | ||
|
||
 | ||
|
||
### Team Collaboration | ||
|
||
Identify relevant team members and ownership information: | ||
|
||
 | ||
|
||
### Code Generation | ||
|
||
Get assistance with creating new projects using Nx generators: | ||
|
||
 |
This file contains 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