|
| 1 | +# Project Setting |
| 2 | + |
| 3 | +The Project Settings module allows you to configure essential project parameters, technical details, secrets, knowledge base, instructions, and usage preferences. Each section within Project Settings serves a unique purpose, providing organized control over the project's configuration. |
| 4 | + |
| 5 | + |
| 6 | +### App Settings |
| 7 | +The App Settings section is where you define key details about your application: |
| 8 | + |
| 9 | +* App Name: The name of your application, displayed in the project dashboard and settings. |
| 10 | +* App Unique ID: A unique identifier for the app, used for integration and project management. |
| 11 | +* App Description: A short description of the app’s purpose or functionality. |
| 12 | +* App GitHub Repo URL: The link to the application's GitHub repository, allowing easy access to the project’s codebase. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +### Technical Info |
| 18 | +The Technical Info section provides information about the technology stack used in the project: |
| 19 | + |
| 20 | +* Project Language: Specifies the primary programming language (e.g., JavaScript, Python). |
| 21 | +* Project Framework: Defines the main framework used in the project (e.g., React, Express). |
| 22 | +* Services: Lists any services integrated within the project, such as databases, APIs, or external tools. |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | +### Secrets |
| 29 | +The Secrets section is used to store and manage sensitive information: |
| 30 | + |
| 31 | +* Add Secret: Allows you to securely add new secrets, such as API keys or passwords. |
| 32 | +* List Secrets: Displays a list of all stored secrets for easy access and management |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +### Knowledge Base |
| 39 | +The Knowledge Base section serves as a repository for important information related to the project: |
| 40 | + |
| 41 | +* Add Knowledge Base Entry: Allows you to add entries to the knowledge base with relevant information, documentation, or FAQs. |
| 42 | +* List Knowledge Base Entries: Displays all knowledge base entries, with options for editing or deletion. |
| 43 | +* Actions: Each entry has actions available for updates or adjustments. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +### Instruction |
| 48 | +There are two ways to add instructions in this section: |
| 49 | + |
| 50 | +* Text Instruction: Use this option to add written instructions directly in text format. |
| 51 | + |
| 52 | +* Local File Instruction: Allows you to upload instructions in the form of files from your local system. |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +### Usage Settings |
| 58 | + |
| 59 | +The Usage section offers various settings to define how the application is used and configured. It includes the following sub-sections: |
| 60 | + |
| 61 | +**Develop Settings** |
| 62 | +* Add Agent: Enables adding new development agents to assist with various tasks. |
| 63 | +* Layout Settings: Customize the layout and organization of the project environment. |
| 64 | +* Run Command: Define commands used to run or test the application in development mode. |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +**Install Settings** |
| 70 | +* Install Custom Agent: Allows installation of custom agents designed for specific tasks or integrations within the project. |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | +**App Use Settings** |
| 76 | +* Customize how the app is used, with options to manage user roles, permissions, or usage guidelines specific to the application. |
| 77 | + |
| 78 | + |
0 commit comments