@Docs

PurecodeAI enables seamless access to both pre-indexed documentation and custom documentation sources, enhancing its ability to provide context-aware suggestions based on external libraries, framework

Pre-Indexed Documentation

By default, PurecodeAI comes with a set of commonly used third-party documentation already indexed and available for contextual assistance. These docs are crawled and ready to be referenced by the AI to enhance the accuracy of suggestions.

How to Use Default Docs:

• Context-Aware Assistance: Simply use the @Docs symbol in the chat to automatically reference the pre-indexed documentation during your development sessions.

• Instant Access: PureCodeAI will automatically consider these docs when providing code suggestions, error explanations, or usage examples.

Add Custom Documentation

If you work with proprietary or lesser-known libraries, frameworks, or internal resources that aren't part of the default index, PureCodeAI lets you index and reference your own custom documentation.

How to Add Custom Docs:

• Using the @Docs Symbol: To add your own documentation, simply type @Docs > Add New Doc followed by the URL of the desired document.

• Indexing the Doc: PureCodeAI will crawl the provided documentation URL, indexing the content for later use. The AI will analyze and learn the structure, relationships, and key elements of the documentation.

  • Tip: If the documentation has multiple subpages, make sure to include the trailing slash (/) in the URL to index all subpages and subdirectories of the documentation.

• Ready for Use: Once indexed, you can refer to this custom documentation with the @Docs symbol just like any other integrated resource.

Manage Custom Documentation

You can manage the documentation you add, such as editing or removing previously indexed sources, through the PureCodeAI Settings.

How to Manage Docs:

• Go to Settings: Navigate to ⚙️ Settings > Features > Docs to access the documentation management area.

• Editing or Deleting Docs:

  • Edit: Modify the URL or update the source if needed.

  • Delete: Remove any documentation that you no longer wish to use for context.

• Re-indexing: If any updates occur in the custom documentation, simply re-add the URL to re-index the latest version for accurate suggestions.

Key Benefits:

• Contextual Relevance: By referencing both default and custom docs, PureCodeAI enhances its ability to give relevant, context-aware code suggestions.

• Flexibility: Whether you're working with well-known frameworks or proprietary libraries, PureCodeAI adapts to your needs by indexing custom documentation.

• Efficiency: Instant access to both third-party and custom docs streamlines your development process, reducing the need for constant manual reference checks.