Core Features5 min read

Knowledge Base

Store and manage reusable documentation that helps AI generate code matching your standards and requirements.

Knowledge Base

The Knowledge Base stores reusable documentation that helps AI generate code matching your standards and requirements. This guide covers creating, managing, and using Knowledge articles.

What Is the Knowledge Base?

The Knowledge Base contains text articles with information AI uses when generating code:
  • Coding standards and style guides
  • API documentation for internal or external services
  • Architecture documentation explaining system design
  • Technical specifications for features or integrations
  • Framework guidelines for libraries you use
When you attach Knowledge articles to a Work Item, AI reads them and follows the guidelines when generating code.

Accessing the Knowledge Base

Click Knowledge in the sidebar to open the Knowledge Base editor.
The editor has two panels:
  • Left panel: List of Knowledge articles organized by scope
  • Right panel: Markdown editor for article content

Creating Knowledge Articles

Create a New Article

  1. Click Create next to the Organization or Project section header
  2. Enter a name for your article (e.g., "React Component Guidelines")
  3. Write your content in the markdown editor
  4. Click Save in the toolbar

Import from Markdown Files

  1. Drag a .md file into the editor
  2. AngenAI creates a new article with the filename as its name
  3. Edit the name and content as needed
  4. Click Save

Article Scopes

Knowledge articles have two scopes:

Organization-Wide

Articles available across all projects in your organization.
Use for:
  • Company-wide coding standards
  • Shared API documentation
  • Common architectural patterns
  • Universal style guides
Note: Only Admins and Owners can create or modify organization-wide articles.

Project-Scoped

Articles available only within a specific project.
Use for:
  • Project-specific conventions
  • Local API endpoints
  • Feature-specific documentation
  • Project architecture notes
Members can create and modify project-scoped articles.

Writing Effective Knowledge Articles

Be Specific and Actionable

Provide clear guidelines AI can follow:
Good example:
## React Component Structure

All React components must:
1. Use functional components with hooks
2. Define TypeScript interfaces for props
3. Export components as named exports
4. Place styles in a separate `.module.css` file

Example:
\`\`\`tsx
interface ButtonProps {
  label: string;
  onClick: () => void;
}

export function Button({ label, onClick }: ButtonProps) {
  return <button onClick={onClick}>{label}</button>;
}
\`\`\`

Include Examples

Show code examples that demonstrate correct implementation:
## Error Handling

Use try-catch blocks with typed error responses:

\`\`\`typescript
try {
  const result = await userService.create(data);
  return { success: true, data: result };
} catch (error) {
  logger.error('User creation failed', { error, data });
  throw new ServiceError('USER_CREATE_FAILED', error);
}
\`\`\`

Document Patterns

Explain patterns and when to use them:
## Repository Pattern

Use the repository pattern for database access:

- Create a repository interface defining methods
- Implement the interface with database-specific code
- Inject repositories into services via dependency injection

This allows swapping databases without changing business logic.

Managing Knowledge Articles

Editing Articles

  1. Select an article from the list
  2. Modify the content in the editor
  3. Click Save to apply changes
Unsaved changes persist in your browser session. A warning appears if you try to leave with unsaved changes.

Renaming Articles

  1. Select the article
  2. Edit the name field above the content editor
  3. Click Save

Duplicating Articles

  1. Select the article
  2. Click the Duplicate button in the toolbar
  3. A copy is created with "(Copy)" appended to the name
  4. Edit and save the duplicate

Moving Between Scopes

Move articles between organization and project scope:
  1. Select the article
  2. Click the Move button in the toolbar
  3. Choose the target scope (Organization or current Project)
  4. Confirm the move
Note: Members cannot move articles to organization scope.

Deleting Articles

  1. Select the article
  2. Click Delete in the toolbar
  3. Confirm deletion
Warning: Deleted articles cannot be recovered.

Using Knowledge in Work Items

From the Context Panel

  1. Open a Work Item
  2. Expand the Knowledge section in the Context Panel
  3. Check the articles you want to include
  4. Click the preview icon to read an article before selecting

Search for Articles

Use the search box in the Knowledge section to filter articles by name.

View Article Content

Click the eye icon next to an article to preview its full content without leaving the Work Item.

Best Practices

Organize by Topic

Create focused articles on specific topics rather than one large document:
  • react-components.md - Component guidelines
  • api-endpoints.md - REST API conventions
  • database-schema.md - Database patterns
  • testing-standards.md - Test requirements

Keep Articles Current

Review and update Knowledge articles when standards change. Outdated information leads to inconsistent code generation.

Start with Core Standards

Begin with articles that cover your most common needs:
  1. Coding style and formatting
  2. Error handling patterns
  3. Component/module structure
  4. Naming conventions
  5. Testing requirements

Use Consistent Formatting

Use markdown headings and code blocks consistently:
  • ## for main sections
  • ### for subsections
  • Code blocks with language hints (```typescript)
  • Bullet points for lists of rules

Troubleshooting

AI Ignores Knowledge Guidelines

  • Check that the article is selected in the Context Panel
  • Verify the article contains clear, specific instructions
  • Include code examples showing correct implementation
  • Reduce the number of selected files to focus attention

Cannot Edit Organization Articles

Only Admins and Owners can modify organization-wide articles. Contact your organization administrator or create a project-scoped version.

Article Not Appearing

  • Refresh the Knowledge Base page
  • Check if you're viewing the correct project
  • Verify the article scope matches your filter

What's Next?