Docs Indexes

Docs Indexes allow you to integrate and organize external documentation sources within the PureCode AI environment. This feature is particularly useful for managing project-specific guides, API references, or any external resources you frequently consult.

How to Use:

1

Access Settings:

Navigate to PureCode AI's settings by clicking on the extension icon and selecting "Settings" right below chat area.

2

Add Documentation

In the Docs Indexes section, you can add new entries by specifying the documentation's name and URL. Alternatively, you can paste the content directly if you prefer to host the documentation locally.

3

Documentation Naming

Fill in the documentation's name (e.g., "Project API Guide") and provide the URL to the online documentation or paste the content directly if hosting it locally.

4

Including Example

Including example usage and detailed descriptions enhances the AI's ability to provide contextually relevant suggestions.

Including example usage and detailed descriptions in your documentation entries will improve the AI's ability to provide contextually relevant suggestions.

---

Examples:

1. Integrating Internal API Documentation:

• Scenario: You're working on a project that interacts with your company's internal APIs.

• Action: Add your internal API documentation to PureCode AI's Docs Indexes.

• Benefit: Quick access to API endpoints and parameters directly within your development environment, reducing context-switching and enhancing productivity.

1. Organizing Codebase Architecture Overviews:

• Scenario: You're onboarding a new module in a large codebase and need to understand its architecture.

• Action: Include architectural diagrams and module overviews in Docs Indexes.

• Benefit: Easier comprehension of the codebase structure, aiding in faster development and collaboration.

1. Managing Third-Party Service Guidelines:

• Scenario: Your application integrates with multiple third-party services like payment gateways or messaging platforms.

• Action: Store the integration guidelines and best practices in Docs Indexes.

• Benefit: Instant reference to integration steps and troubleshooting tips, streamlining the development process.

---

Benefits

• Centralized Access: Keeps all your essential documentation within easy reach, reducing the time spent searching for external resources.

• Contextual Assistance: Enables PureCode AI to reference your custom documentation, offering more precise and tailored code suggestions.