Skip to main content

Local Docs

Introduction

Local Docs is a local documentation management feature provided by CodeSouler, allowing users to create and manage design documents locally within their projects. Through this feature, you can better organize and track design decisions and requirement documents related to your project.

1. Creating Local Docs​

Creation Steps Please follow these steps to create Local Docs:

  1. Create a .codesouler/docs folder in your project root directory (if not already created).

  2. Create an issue_name.md file in this folder, for example: IDE Plugin Development Design Document. This is used to manage requirement design documents.

  3. Write your document content using Markdown format, supporting standard Markdown syntax such as headings, lists, code blocks, etc.

  4. You can create multiple documents as needed, and it's recommended to use meaningful filenames to organize different documents.

img

2. Using Local Docs​

Usage Steps Please follow these steps to use Local Docs:

  1. Enter the +LocalDocs command in the CodeSouler dialog.

  2. The system will display a list of all available local documents in the current project.

  3. Select the document you want to associate from the list.

  4. The selected document will be added to the conversation context, and you can ask questions based on the document content.

  5. You can switch or add other documents at any time during the conversation.

img

3. Best Practices​

Recommendations To use Local Docs more effectively, we recommend:

  1. Maintain clear document structure using appropriate heading levels.

  2. Regularly update document content to ensure information is timely and accurate.

  3. Create separate documents for different functional modules.

  4. Include necessary context information in documents for future reference.

  5. Use Markdown's code block feature to showcase code examples.