-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Document Agent Knowledge Base feature #197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: Agent Knowledge Base | ||
| description: View and edit the files that help Promptless understand your documentation style, product context, and workflow preferences | ||
| --- | ||
|
|
||
| Promptless updates these files automatically as it learns from your feedback, but you can also edit them directly. | ||
|
|
||
| ## Accessing the Agent Knowledge Base | ||
|
|
||
| Go to **Settings** and click the **Agent Knowledge Base** tab. If you have multiple docs repositories connected, select the one you want from the dropdown. | ||
|
|
||
| <Frame> | ||
| <img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/agent-knowledge-base-overview-23525115.png" alt="Agent Knowledge Base interface showing the file tree, recent updates, and editor" /> | ||
| </Frame> | ||
|
|
||
| ## Recent Updates by Promptless | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Citation: The "Recent updates by Promptless" feature was added in a later commit to PR #1826 (see |
||
| View recent updates Promptless has made to these files based on your feedback. | ||
|
|
||
| Each update includes: | ||
| - Date of the update | ||
| - Files changed | ||
| - Link to the suggestion that triggered the update | ||
|
|
||
| This shows how your feedback shapes Promptless's understanding of your documentation preferences. | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Citation: File descriptions sourced from |
||
| ## Knowledge Base Files | ||
|
|
||
| | File | Purpose | | ||
| |------|---------| | ||
| | `client_instructions.md` | Guidelines for how Promptless approaches documentation tasks. Updated when Promptless learns new preferences from your feedback. | | ||
| | `default_plan_skeleton.md` | Template structure for documentation plans. Updated when you provide feedback on plan organization. | | ||
| | `product_overview.md` | High-level context about your product. Generated during initial setup—you can edit this directly or request Promptless to regenerate it. | | ||
| | `client_style_guide.md` | Writing style rules and conventions. If your repo includes a style guide or Vale rules, reference those files here. Promptless updates this file as it learns your style preferences from feedback. | | ||
|
|
||
| ## Viewing and Editing Files | ||
|
|
||
| Click any file in the tree view to open it in the editor. | ||
|
|
||
| <Frame> | ||
| <img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/agent-knowledge-base-file-editor-20aa3e56.png" alt="Agent Knowledge Base showing a file selected in the tree and its content in the editor" /> | ||
| </Frame> | ||
|
|
||
| To edit a file: | ||
|
|
||
| 1. Make your changes in the editor | ||
| 2. Click **Save** | ||
| 3. Your changes are committed directly to the repository | ||
|
|
||
| <Warning> | ||
| Switching files with unsaved changes will discard those changes. | ||
| </Warning> | ||
|
|
||
| ## How Promptless Uses These Files | ||
|
|
||
| Promptless reads these files at the start of every documentation task to understand your documentation approach, product terminology, and writing style. | ||
|
|
||
| When you provide feedback on suggestions—through PR comments, the web interface, or Slack—Promptless may update these files to apply what it learned to future tasks. | ||
|
|
||
| Need help? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Citation: Based on PR #1826 which adds
AgentKnowledgeTab.tsxto Settings. File descriptions fromFILE_DESCRIPTIONSobject in the component (lines 95-100) document what each knowledge base file is used for.View source