chore: update README.md and docs with Brainy logo and enhanced formatting

Standardized documentation by adding a centered Brainy logo across README files, examples, and guides. Adjusted text formatting for consistency, improved alignment, and readability of feature descriptions and examples.
This commit is contained in:
David Snelling 2025-06-11 08:49:30 -07:00
parent 21ae491913
commit 0b7b3f947b
11 changed files with 739 additions and 655 deletions

View file

@ -1,4 +1,8 @@
<div align="center">
<img src="../../brainy.png" alt="Brainy Logo" width="200"/>
# Brainy Augmentations
</div>
This directory contains the augmentation implementations for Brainy. Augmentations are pluggable components that extend Brainy's functionality in various ways.
@ -191,31 +195,31 @@ class MyCustomActivation implements IActivationAugmentation {
readonly name = 'my-custom-activation'
readonly description = 'My custom activation augmentation'
enabled = true
getType(): AugmentationType {
return AugmentationType.ACTIVATION
}
async initialize(): Promise<void> {
// Initialization code
}
async shutDown(): Promise<void> {
// Cleanup code
}
async getStatus(): Promise<'active' | 'inactive' | 'error'> {
return 'active'
}
triggerAction(actionName: string, parameters?: Record<string, unknown>): AugmentationResponse<unknown> {
// Implementation
}
generateOutput(knowledgeId: string, format: string): AugmentationResponse<string | Record<string, unknown>> {
// Implementation
}
interactExternal(systemId: string, payload: Record<string, unknown>): AugmentationResponse<unknown> {
// Implementation
}