@app-studio/web 0.9.20 → 0.9.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/README.md +17 -1
  2. package/dist/components/ChatInput/ChatInput/ChatInput.props.d.ts +9 -0
  3. package/dist/components/ChatInput/EditableInput.d.ts +1 -1
  4. package/dist/components/adk/AgentChat/AgentChat/AgentChat.props.d.ts +26 -3
  5. package/dist/components/adk/AgentChat/examples/default.d.ts +1 -1
  6. package/dist/components/adk/AgentEval/AgentEval/AgentEval.props.d.ts +33 -2
  7. package/dist/components/adk/AgentSession/AgentSession/AgentSession.props.d.ts +23 -1
  8. package/dist/components/adk/AgentSession/examples/default.d.ts +6 -0
  9. package/dist/components/adk/AgentTrace/AgentTrace/AgentTrace.props.d.ts +38 -3
  10. package/dist/services/api/index.d.ts +6 -17
  11. package/dist/services/api/models/ActionListParam.d.ts +18 -0
  12. package/dist/services/api/models/CheckRatingParams.d.ts +1 -1
  13. package/dist/services/api/models/CreateActionParams.d.ts +1 -13
  14. package/dist/services/api/models/CreateAnalyticParams.d.ts +1 -1
  15. package/dist/services/api/models/CreateCommentAnswerParams.d.ts +1 -1
  16. package/dist/services/api/models/CreateCommentParams.d.ts +1 -1
  17. package/dist/services/api/models/CreateRatingParams.d.ts +1 -1
  18. package/dist/services/api/models/CreateReportParams.d.ts +1 -1
  19. package/dist/services/api/models/EditLogoParams.d.ts +22 -0
  20. package/dist/services/api/models/EditPageStreamParams.d.ts +6 -0
  21. package/dist/services/api/models/FindCommentParams.d.ts +1 -1
  22. package/dist/services/api/models/FindReportParams.d.ts +1 -1
  23. package/dist/services/api/models/FindUserParams.d.ts +1 -1
  24. package/dist/services/api/models/GenerateProjectParams.d.ts +0 -4
  25. package/dist/services/api/models/GetAnalyticViewParams.d.ts +1 -1
  26. package/dist/services/api/models/ListCommentParams.d.ts +1 -1
  27. package/dist/services/api/models/SetAnalyticViewParams.d.ts +1 -1
  28. package/dist/services/api/models/UpdateActionParams.d.ts +2 -2
  29. package/dist/services/api/models/UpdateObjectDto.d.ts +1 -0
  30. package/dist/services/api/models/UpdateUserParams.d.ts +14 -6
  31. package/dist/services/api/services/ActionService.d.ts +90 -30
  32. package/dist/services/api/services/AssistantService.d.ts +12 -0
  33. package/dist/services/api/services/ComponentService.d.ts +22 -38
  34. package/dist/services/api/services/FieldService.d.ts +2 -2
  35. package/dist/services/api/services/ItemService.d.ts +13 -0
  36. package/dist/services/api/services/NewsletterService.d.ts +2 -2
  37. package/dist/services/api/services/ObjectService.d.ts +74 -0
  38. package/dist/services/api/services/PageService.d.ts +0 -60
  39. package/dist/services/api/services/SeedService.d.ts +4 -4
  40. package/dist/services/api/services/UploadService.d.ts +55 -0
  41. package/dist/services/api/services/WorkflowService.d.ts +24 -25
  42. package/dist/utils/apiConfig.d.ts +24 -0
  43. package/dist/web.cjs.development.js +85 -12
  44. package/dist/web.cjs.development.js.map +1 -1
  45. package/dist/web.cjs.production.min.js +1 -1
  46. package/dist/web.cjs.production.min.js.map +1 -1
  47. package/dist/web.esm.js +85 -12
  48. package/dist/web.esm.js.map +1 -1
  49. package/dist/web.umd.development.js +85 -12
  50. package/dist/web.umd.development.js.map +1 -1
  51. package/dist/web.umd.production.min.js +1 -1
  52. package/dist/web.umd.production.min.js.map +1 -1
  53. package/docs/README.md +21 -14
  54. package/docs/adk-customization-guide.md +204 -0
  55. package/docs/adk-customization-summary.md +157 -0
  56. package/docs/documentation-system.md +90 -0
  57. package/package.json +2 -1
  58. package/dist/services/api/models/CreateApplicationParams.d.ts +0 -10
  59. package/dist/services/api/models/CreateGrantParams.d.ts +0 -10
  60. package/dist/services/api/models/CreateProjectParams.d.ts +0 -10
  61. package/dist/services/api/models/FindApplicationParams.d.ts +0 -19
  62. package/dist/services/api/models/FindPageParams.d.ts +0 -22
  63. package/dist/services/api/models/FixPageParams.d.ts +0 -10
  64. package/dist/services/api/models/UpdateApplicationParams.d.ts +0 -6
  65. package/dist/services/api/models/UpdateComponentPropsParams.d.ts +0 -10
  66. package/dist/services/api/models/UpdateGrantParams.d.ts +0 -6
  67. package/dist/services/api/models/UpdatePageParams.d.ts +0 -14
  68. package/dist/services/api/models/UpdateProjectParams.d.ts +0 -10
  69. package/dist/services/api/services/ApplicationService.d.ts +0 -83
  70. package/dist/services/api/services/ComponentRevisionService.d.ts +0 -25
  71. package/dist/services/api/services/FileService.d.ts +0 -30
  72. package/dist/services/api/services/GrantService.d.ts +0 -100
  73. package/dist/services/api/services/ProjectService.d.ts +0 -59
  74. package/dist/services/api/services/PromptService.d.ts +0 -18
  75. package/docs/guide.md +0 -550
  76. package/docs/integration-guide.md +0 -449
package/docs/README.md CHANGED
@@ -1,24 +1,31 @@
1
1
  # App Studio Web Component Library Documentation
2
2
 
3
- Welcome to the documentation for the App Studio Web Component Library. This documentation provides comprehensive guides, API references, and examples to help you build high-quality components and applications using our library.
3
+ Welcome to the comprehensive documentation for the App Studio Web Component Library. This documentation provides guides, API references, and examples to help you build high-quality components and applications.
4
4
 
5
- ## Documentation Structure
5
+ ## 📖 Documentation Structure
6
6
 
7
- - **Getting Started**: Quick start guides to help you begin using the library
8
- - **Component Development**: Detailed guides for building components
9
- - **Design System**: Information about the design system, theming, and styling
10
- - **API Reference**: Detailed API documentation for all components
11
- - **Tutorials**: Step-by-step tutorials for common tasks
12
- - **Contributing**: Guidelines for contributing to the library
7
+ ### Core Documentation
8
+ - **[Getting Started](./getting-started/introduction.md)** - Quick introduction and setup
9
+ - **[Component Development](./component-development/guide.md)** - Building and contributing components
10
+ - **[API Integration](./api-integration.md)** - Backend integration patterns
11
+ - **[Design System](./design-system/theming.md)** - Theming and styling guidelines
13
12
 
14
- ## Using This Documentation
13
+ ### Specialized Documentation
14
+ - **[ADK Components](../README-ADK.md)** - Agent Development Kit integration
15
+ - **[API Reference](./api-reference/README.md)** - Detailed component APIs
16
+ - **[Tutorials](./tutorials/README.md)** - Step-by-step guides
17
+ - **[Contributing](./contributing/documentation.md)** - Contribution guidelines
15
18
 
16
- The documentation is organized to support different learning styles and needs:
19
+ ## 🚀 Quick Navigation
17
20
 
18
- - If you're new to the library, start with the [Getting Started](./getting-started/introduction.md) guide
19
- - If you're building components, refer to the [Component Development Guide](./component-development/guide.md)
20
- - If you need detailed API information, check the [API Reference](./api-reference/README.md)
21
- - If you want to learn through examples, explore the [Tutorials](./tutorials/README.md)
21
+ ### For New Users
22
+ Start with the [Getting Started Guide](./getting-started/introduction.md) to understand the library basics and setup process.
23
+
24
+ ### For Developers
25
+ Refer to the [Component Development Guide](./component-development/guide.md) for building and customizing components.
26
+
27
+ ### For ADK Integration
28
+ Check the [ADK Components documentation](../README-ADK.md) for agent-specific functionality.
22
29
 
23
30
  ## Documentation Tools
24
31
 
@@ -0,0 +1,204 @@
1
+ # ADK Components Customization Guide
2
+
3
+ This guide demonstrates how to customize ADK components using the enhanced `views` prop and `containerProps` for complete control over appearance and behavior.
4
+
5
+ ## Overview
6
+
7
+ All ADK components now support comprehensive customization through:
8
+
9
+ 1. **Enhanced `views` prop** - Granular control over individual component parts
10
+ 2. **Container props** - Direct styling of the main container
11
+ 3. **Theme props** - Built-in color schemes and layout options
12
+ 4. **Responsive design** - Automatic adaptation across devices
13
+
14
+ ## Component Customization
15
+
16
+ ### AgentChat Component
17
+
18
+ The AgentChat component supports extensive customization of all its parts:
19
+
20
+ ```tsx
21
+ <AgentChat
22
+ appName="my-agent"
23
+ userId="user123"
24
+ colorScheme="purple"
25
+ compact={false}
26
+ rounded={true}
27
+ containerProps={{
28
+ backgroundColor: 'color.purple.25',
29
+ border: '2px solid',
30
+ borderColor: 'color.purple.300',
31
+ }}
32
+ views={{
33
+ // Main areas
34
+ container: { backgroundColor: 'color.purple.25' },
35
+ header: { backgroundColor: 'color.purple.500', color: 'white' },
36
+ messageList: { backgroundColor: 'color.white', padding: '20px' },
37
+ inputArea: { backgroundColor: 'color.purple.50', padding: '16px' },
38
+
39
+ // Message styling
40
+ userMessage: {
41
+ backgroundColor: 'color.purple.500',
42
+ color: 'white',
43
+ borderRadius: '18px 18px 4px 18px',
44
+ padding: '12px 16px',
45
+ },
46
+ botMessage: {
47
+ backgroundColor: 'color.purple.100',
48
+ color: 'color.purple.900',
49
+ borderRadius: '18px 18px 18px 4px',
50
+ padding: '12px 16px',
51
+ },
52
+
53
+ // Input components
54
+ inputField: {
55
+ borderRadius: '24px',
56
+ border: '2px solid',
57
+ borderColor: 'color.purple.200',
58
+ },
59
+ sendButton: {
60
+ backgroundColor: 'color.purple.500',
61
+ borderRadius: '50%',
62
+ },
63
+
64
+ // State indicators
65
+ typingIndicator: {
66
+ color: 'color.purple.600',
67
+ backgroundColor: 'color.purple.100',
68
+ borderRadius: '16px',
69
+ },
70
+
71
+ // Function calls and code
72
+ functionCall: {
73
+ backgroundColor: 'color.purple.50',
74
+ border: '1px solid',
75
+ borderColor: 'color.purple.200',
76
+ borderRadius: '8px',
77
+ },
78
+ codeBlock: {
79
+ backgroundColor: 'color.gray.900',
80
+ color: 'color.gray.100',
81
+ borderRadius: '8px',
82
+ },
83
+ }}
84
+ />
85
+ ```
86
+
87
+ ### AgentSession Component
88
+
89
+ The AgentSession component provides comprehensive session management customization:
90
+
91
+ ```tsx
92
+ <AgentSession
93
+ appName="my-agent"
94
+ userId="user123"
95
+ colorScheme="green"
96
+ layout="list"
97
+ showPreviews={true}
98
+ enableBulkOperations={true}
99
+ containerProps={{
100
+ backgroundColor: 'color.green.25',
101
+ border: '2px solid',
102
+ borderColor: 'color.green.300',
103
+ }}
104
+ views={{
105
+ // Main areas
106
+ container: { backgroundColor: 'color.green.25' },
107
+ header: { backgroundColor: 'color.green.500', color: 'white' },
108
+ sessionList: { backgroundColor: 'color.white', padding: '16px' },
109
+
110
+ // Session items
111
+ sessionItem: {
112
+ backgroundColor: 'color.green.50',
113
+ borderRadius: '8px',
114
+ padding: '12px',
115
+ border: '1px solid',
116
+ borderColor: 'color.green.200',
117
+ },
118
+ activeSessionItem: {
119
+ backgroundColor: 'color.green.100',
120
+ borderColor: 'color.green.500',
121
+ borderWidth: '2px',
122
+ },
123
+
124
+ // Session content
125
+ sessionTitle: { fontWeight: '600', color: 'color.green.900' },
126
+ sessionDescription: { color: 'color.green.700' },
127
+ sessionTimestamp: { color: 'color.green.600', fontSize: '12px' },
128
+
129
+ // Action buttons
130
+ createButton: {
131
+ backgroundColor: 'color.green.500',
132
+ color: 'white',
133
+ borderRadius: '8px',
134
+ },
135
+ deleteButton: {
136
+ backgroundColor: 'color.red.500',
137
+ color: 'white',
138
+ borderRadius: '6px',
139
+ },
140
+
141
+ // Search and filters
142
+ searchInput: {
143
+ borderRadius: '20px',
144
+ border: '2px solid',
145
+ borderColor: 'color.green.200',
146
+ },
147
+ }}
148
+ />
149
+ ```
150
+
151
+ ## Available Views Properties
152
+
153
+ ### AgentChat Views
154
+
155
+ - **Main Areas**: `container`, `header`, `messageList`, `inputArea`, `attachmentArea`
156
+ - **Messages**: `message`, `userMessage`, `botMessage`, `systemMessage`, `messageContent`, `messageTimestamp`, `messageAvatar`, `messageActions`
157
+ - **Input**: `inputField`, `sendButton`, `attachButton`, `recordButton`, `inputToolbar`
158
+ - **States**: `loadingIndicator`, `typingIndicator`, `errorMessage`, `emptyState`
159
+ - **Features**: `functionCall`, `functionResponse`, `codeBlock`, `codeOutput`, `thoughtBubble`
160
+ - **Attachments**: `attachmentPreview`, `attachmentItem`, `attachmentRemoveButton`
161
+
162
+ ### AgentSession Views
163
+
164
+ - **Main Areas**: `container`, `header`, `toolbar`, `sessionList`, `sessionActions`, `filtersPanel`
165
+ - **Session Items**: `sessionItem`, `activeSessionItem`, `sessionInfo`, `sessionTitle`, `sessionDescription`, `sessionMetadata`, `sessionTimestamp`, `sessionTags`, `sessionStats`
166
+ - **Actions**: `createButton`, `deleteButton`, `exportButton`, `importButton`, `refreshButton`, `selectButton`, `duplicateButton`
167
+ - **Search/Filter**: `searchInput`, `filterDropdown`, `sortDropdown`, `dateRangePicker`, `tagFilter`
168
+ - **States**: `emptyState`, `loadingState`, `errorState`
169
+ - **Bulk Operations**: `bulkActions`, `selectAllCheckbox`, `bulkDeleteButton`, `bulkExportButton`
170
+
171
+ ## Theme Options
172
+
173
+ ### Color Schemes
174
+ - `blue` (default)
175
+ - `purple`
176
+ - `green`
177
+ - `orange`
178
+ - `red`
179
+ - `gray`
180
+
181
+ ### Layout Options
182
+
183
+ **AgentSession Layouts:**
184
+ - `list` - Vertical list layout
185
+ - `grid` - Grid layout for sessions
186
+ - `compact` - Condensed view
187
+
188
+ **AgentTrace Layouts:**
189
+ - `timeline` - Timeline visualization
190
+ - `tree` - Tree structure
191
+ - `table` - Tabular view
192
+ - `graph` - Graph visualization
193
+
194
+ ## Best Practices
195
+
196
+ 1. **Consistent Color Schemes**: Use the same color scheme across related components
197
+ 2. **Responsive Design**: Test customizations across different screen sizes
198
+ 3. **Accessibility**: Ensure sufficient color contrast and readable fonts
199
+ 4. **Performance**: Avoid overly complex styling that might impact performance
200
+ 5. **Maintainability**: Use design tokens from the app-studio color system
201
+
202
+ ## Examples
203
+
204
+ See the enhanced examples in each component's `examples/default.tsx` file for comprehensive demonstrations of all customization options.
@@ -0,0 +1,157 @@
1
+ # ADK Components Customization Enhancement Summary
2
+
3
+ ## Overview
4
+
5
+ The ADK components have been enhanced with comprehensive customization capabilities through expanded `views` props and new container customization options. This provides developers with granular control over every aspect of the component appearance and behavior.
6
+
7
+ ## Key Enhancements
8
+
9
+ ### 1. Enhanced Views Props
10
+
11
+ All ADK components now support significantly more granular customization through expanded `views` interfaces:
12
+
13
+ #### AgentChat Views (40+ customizable parts)
14
+ - **Main Areas**: container, header, messageList, inputArea, attachmentArea
15
+ - **Message Components**: userMessage, botMessage, systemMessage, messageContent, messageTimestamp, messageAvatar, messageActions
16
+ - **Input Components**: inputField, sendButton, attachButton, recordButton, inputToolbar
17
+ - **State Indicators**: loadingIndicator, typingIndicator, errorMessage, emptyState
18
+ - **Feature Components**: functionCall, functionResponse, codeBlock, codeOutput, thoughtBubble
19
+ - **Attachment Components**: attachmentPreview, attachmentItem, attachmentRemoveButton
20
+
21
+ #### AgentSession Views (40+ customizable parts)
22
+ - **Main Areas**: container, header, toolbar, sessionList, sessionActions, filtersPanel
23
+ - **Session Items**: sessionItem, activeSessionItem, sessionInfo, sessionTitle, sessionDescription, sessionMetadata, sessionTimestamp, sessionTags, sessionStats
24
+ - **Action Buttons**: createButton, deleteButton, exportButton, importButton, refreshButton, selectButton, duplicateButton
25
+ - **Search/Filter**: searchInput, filterDropdown, sortDropdown, dateRangePicker, tagFilter
26
+ - **Bulk Operations**: bulkActions, selectAllCheckbox, bulkDeleteButton, bulkExportButton
27
+
28
+ #### AgentEval Views (50+ customizable parts)
29
+ - **Main Areas**: container, header, toolbar, evaluationList, createPanel, resultsPanel, metricsPanel
30
+ - **Evaluation Items**: evaluationItem, activeEvaluationItem, evaluationTitle, evaluationStatus, evaluationProgress
31
+ - **Test Cases**: testCaseList, testCaseItem, testCaseInput, testCaseOutput, testCaseResult
32
+ - **Progress/Status**: progressBar, statusIndicator, statusBadge, scoreDisplay, durationDisplay
33
+ - **Visualization**: chartContainer, metricsChart, resultsTable, summaryCard
34
+
35
+ #### AgentTrace Views (50+ customizable parts)
36
+ - **Main Areas**: container, header, toolbar, timeline, eventList, detailsPanel, metricsPanel
37
+ - **Event Components**: eventItem, selectedEventItem, eventHeader, eventContent, eventMetadata
38
+ - **Timeline**: timelineContainer, timelineAxis, timelineEvent, timelineSpan, timelineMarker
39
+ - **Metrics**: metricsCard, performanceChart, errorRateChart, latencyChart, throughputChart
40
+ - **Visualization**: flowDiagram, dependencyGraph, heatmap
41
+
42
+ ### 2. Container Props Support
43
+
44
+ All components now accept `containerProps` for direct styling of the main container:
45
+
46
+ ```tsx
47
+ <AgentChat
48
+ containerProps={{
49
+ backgroundColor: 'color.purple.25',
50
+ border: '2px solid',
51
+ borderColor: 'color.purple.300',
52
+ borderRadius: '12px',
53
+ }}
54
+ />
55
+ ```
56
+
57
+ ### 3. Theme and Appearance Props
58
+
59
+ New theme-related props for consistent styling:
60
+
61
+ - **colorScheme**: `'blue' | 'purple' | 'green' | 'orange' | 'red' | 'gray'`
62
+ - **layout**: Component-specific layout options
63
+ - **compact**: Boolean for condensed layouts
64
+ - **rounded**: Boolean for rounded corners
65
+ - **showPreviews**: Boolean for preview features
66
+
67
+ ### 4. Dynamic Styling
68
+
69
+ Components now include dynamic styling functions that apply theme-based styles automatically:
70
+
71
+ ```tsx
72
+ const getThemeStyles = () => {
73
+ const colorStyles = {
74
+ blue: { borderColor: 'color.blue.200' },
75
+ purple: { borderColor: 'color.purple.200' },
76
+ // ... other colors
77
+ };
78
+ return colorStyles[colorScheme];
79
+ };
80
+ ```
81
+
82
+ ## Implementation Details
83
+
84
+ ### File Changes
85
+
86
+ 1. **Props Interfaces Enhanced**:
87
+ - `AgentChat/AgentChat.props.ts` - Expanded AgentChatViews interface
88
+ - `AgentSession/AgentSession.props.ts` - Expanded AgentSessionViews interface
89
+ - `AgentEval/AgentEval.props.ts` - Expanded AgentEvalViews interface
90
+ - `AgentTrace/AgentTrace.props.ts` - Expanded AgentTraceViews interface
91
+
92
+ 2. **View Components Updated**:
93
+ - `AgentChat/AgentChat.view.tsx` - Added theme support and containerProps
94
+ - `AgentSession/AgentSession.view.tsx` - Added theme support and containerProps
95
+
96
+ 3. **Examples Enhanced**:
97
+ - `AgentChat/examples/default.tsx` - Comprehensive customization example
98
+ - `AgentSession/examples/default.tsx` - Enhanced customization example
99
+
100
+ 4. **Documentation Created**:
101
+ - `docs/adk-customization-guide.md` - Complete customization guide
102
+ - `docs/adk-customization-summary.md` - This summary document
103
+
104
+ ## Usage Examples
105
+
106
+ ### Basic Customization
107
+ ```tsx
108
+ <AgentChat
109
+ appName="my-agent"
110
+ userId="user123"
111
+ colorScheme="purple"
112
+ views={{
113
+ userMessage: { backgroundColor: 'color.purple.500' },
114
+ botMessage: { backgroundColor: 'color.purple.100' },
115
+ }}
116
+ />
117
+ ```
118
+
119
+ ### Advanced Customization
120
+ ```tsx
121
+ <AgentSession
122
+ appName="my-agent"
123
+ userId="user123"
124
+ colorScheme="green"
125
+ layout="grid"
126
+ containerProps={{ backgroundColor: 'color.green.25' }}
127
+ views={{
128
+ sessionItem: {
129
+ backgroundColor: 'color.green.50',
130
+ borderRadius: '8px',
131
+ padding: '12px',
132
+ },
133
+ activeSessionItem: {
134
+ backgroundColor: 'color.green.100',
135
+ borderColor: 'color.green.500',
136
+ },
137
+ }}
138
+ />
139
+ ```
140
+
141
+ ## Benefits
142
+
143
+ 1. **Complete Control**: Developers can customize every visual aspect of the components
144
+ 2. **Consistent Theming**: Built-in color schemes ensure visual consistency
145
+ 3. **Responsive Design**: Components adapt to different layouts and screen sizes
146
+ 4. **Maintainable**: Uses app-studio design tokens for consistent styling
147
+ 5. **Flexible**: Supports both simple theme-based and complex custom styling
148
+
149
+ ## Next Steps
150
+
151
+ The enhanced customization system provides a solid foundation for:
152
+ - Creating branded component themes
153
+ - Building custom layouts and designs
154
+ - Implementing responsive component behaviors
155
+ - Maintaining visual consistency across applications
156
+
157
+ All components are now ready for comprehensive customization while maintaining their core functionality and accessibility features.
@@ -104,8 +104,50 @@ To update component documentation:
104
104
  2. Review the generated documentation
105
105
  3. Make any necessary manual adjustments
106
106
 
107
+ ## Documentation Maintenance Rules
108
+
109
+ ### Rule 1: Single Source of Truth
110
+ - Each topic should have ONE authoritative documentation file
111
+ - Avoid duplicating content across multiple files
112
+ - Use cross-references instead of copying content
113
+ - **Prohibited**: Creating multiple files covering the same topic
114
+
115
+ ### Rule 2: Clear File Responsibilities
116
+ - **README.md**: Project overview, quick start, navigation to specialized docs
117
+ - **README-ADK.md**: ADK-specific functionality ONLY
118
+ - **docs/README.md**: Documentation hub and navigation
119
+ - **docs/api-integration.md**: Backend integration patterns
120
+ - **Component docs**: Individual component usage and APIs
121
+
122
+ ### Rule 3: Content Validation Checklist
123
+ Before adding/updating documentation:
124
+ - ✅ Check for existing content on the same topic
125
+ - ✅ Verify all code examples work
126
+ - ✅ Ensure links are valid and up-to-date
127
+ - ✅ Follow consistent markdown formatting
128
+ - ✅ Update related files if needed
129
+ - ✅ Remove outdated information
130
+
131
+ ### Rule 4: Mandatory Updates
132
+ Documentation MUST be updated when:
133
+ - Adding new components or features
134
+ - Changing component APIs or props
135
+ - Modifying integration patterns
136
+ - Updating dependencies or requirements
137
+ - Changing project structure
138
+
139
+ ### Rule 5: Quality Standards
140
+ - Use clear, concise language
141
+ - Include practical, working examples
142
+ - Follow consistent formatting and terminology
143
+ - Link related documentation appropriately
144
+ - Test all code examples before publishing
145
+ - Include accessibility information where relevant
146
+ - Document best practices and common pitfalls
147
+
107
148
  ## Documentation Best Practices
108
149
 
150
+ ### Content Organization
109
151
  - Keep documentation up-to-date with code changes
110
152
  - Include examples for all components and features
111
153
  - Use consistent formatting and terminology
@@ -114,6 +156,45 @@ To update component documentation:
114
156
  - Include accessibility information
115
157
  - Document best practices and common pitfalls
116
158
 
159
+ ### File Naming Conventions
160
+ - Use kebab-case for file names: `component-development.md`
161
+ - Use descriptive names that clearly indicate content
162
+ - Avoid generic names like `guide.md` or `docs.md`
163
+
164
+ ## Documentation Maintenance Workflow
165
+
166
+ ### Before Making Changes
167
+ 1. **Audit existing documentation**:
168
+ ```bash
169
+ # Check for duplicate content
170
+ grep -r "your-search-term" docs/
171
+
172
+ # Find broken links
173
+ find docs/ -name "*.md" -exec grep -l "broken-link" {} \;
174
+ ```
175
+
176
+ 2. **Validate current structure**:
177
+ - Ensure no topic is covered in multiple files
178
+ - Check that all links work
179
+ - Verify code examples are current
180
+
181
+ ### After Making Changes
182
+ 1. **Update related documentation**:
183
+ - Update cross-references
184
+ - Check for outdated information
185
+ - Ensure consistency across files
186
+
187
+ 2. **Run documentation tools**:
188
+ ```bash
189
+ npm run create-docs
190
+ npm run bot-doc -- ComponentName src/components/ComponentName
191
+ ```
192
+
193
+ ### Regular Maintenance Tasks
194
+ - **Weekly**: Check for broken links and outdated examples
195
+ - **Monthly**: Review documentation structure for redundancies
196
+ - **Per Release**: Update all version-specific information
197
+
117
198
  ## Troubleshooting
118
199
 
119
200
  If you encounter issues with the documentation system:
@@ -141,3 +222,12 @@ If MDX files are not rendering correctly:
141
222
  1. Check the MDX syntax
142
223
  2. Ensure the MDX file is in the correct location
143
224
  3. Check for errors in the console
225
+
226
+ ### Duplicate Content Issues
227
+
228
+ If you find duplicate content:
229
+
230
+ 1. Identify the authoritative source
231
+ 2. Remove duplicate content
232
+ 3. Add cross-references to the authoritative source
233
+ 4. Update any links pointing to removed content
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@app-studio/web",
3
- "version": "0.9.20",
3
+ "version": "0.9.22",
4
4
  "main": "dist/index.js",
5
5
  "typings": "dist/components/index.d.ts",
6
6
  "files": [
@@ -46,6 +46,7 @@
46
46
  "create-example": "ts-node scripts/create-example.ts",
47
47
  "page-imports": "ts-node scripts/generate-page-imports.ts",
48
48
  "create-pages": "npm run create-indices && ts-node scripts/create-pages.ts && npm run page-imports",
49
+ "validate-docs": "node scripts/validate-docs.js",
49
50
  "api:local": "react-api --useUnionTypes --input http://localhost:3000/docs/swagger.json --output ./src/services/api && prettier --write ./src/services/api"
50
51
  },
51
52
  "eslintConfig": {
@@ -1,10 +0,0 @@
1
- export declare type CreateApplicationParams = {
2
- /**
3
- * Grant Id to be assigned to the application to be created.
4
- */
5
- grantId?: string;
6
- /**
7
- * Project Id to be assigned to the application to be created.
8
- */
9
- projectId?: string;
10
- };
@@ -1,10 +0,0 @@
1
- export declare type CreateGrantParams = {
2
- /**
3
- * The title of the grant to be created.
4
- */
5
- name: string;
6
- /**
7
- * The project Id of the grant
8
- */
9
- projectId: string;
10
- };
@@ -1,10 +0,0 @@
1
- export declare type CreateProjectParams = {
2
- /**
3
- * The name of the project to be created.
4
- */
5
- name: string;
6
- /**
7
- * The description of the project to be created.
8
- */
9
- description?: string;
10
- };
@@ -1,19 +0,0 @@
1
- export declare type FindApplicationParams = {
2
- name?: string;
3
- /**
4
- * Order by field
5
- */
6
- sortField?: 'id' | 'userId' | 'name' | 'imageUrl' | 'image' | 'createdAt' | 'updatedAt';
7
- /**
8
- * Order sort
9
- */
10
- sortOrder?: 'asc' | 'desc';
11
- /**
12
- * Number or result to return
13
- */
14
- take?: number;
15
- /**
16
- * Number or result to skip
17
- */
18
- skip?: number;
19
- };
@@ -1,22 +0,0 @@
1
- export declare type FindPageParams = {
2
- /**
3
- * Page Id
4
- */
5
- projectId: string;
6
- /**
7
- * Order by field
8
- */
9
- sortField?: string;
10
- /**
11
- * Order sort
12
- */
13
- sortOrder?: string;
14
- /**
15
- * Number or result to return
16
- */
17
- take?: number;
18
- /**
19
- * Number or result to skip
20
- */
21
- skip?: number;
22
- };
@@ -1,10 +0,0 @@
1
- export declare type FixPageParams = {
2
- /**
3
- * User requirement
4
- */
5
- prompt: string;
6
- /**
7
- * Selected Html Element
8
- */
9
- html: string;
10
- };
@@ -1,6 +0,0 @@
1
- export declare type UpdateApplicationParams = {
2
- /**
3
- * Application title
4
- */
5
- name: string;
6
- };
@@ -1,10 +0,0 @@
1
- export declare type UpdateComponentPropsParams = {
2
- /**
3
- * Prompt
4
- */
5
- prompt: string;
6
- /**
7
- * Json Content
8
- */
9
- json: any;
10
- };
@@ -1,6 +0,0 @@
1
- export declare type UpdateGrantParams = {
2
- /**
3
- * Grant title
4
- */
5
- name: string;
6
- };
@@ -1,14 +0,0 @@
1
- export declare type UpdatePageParams = {
2
- /**
3
- * The code to be associated with the page
4
- */
5
- code?: string;
6
- /**
7
- * The configs to be associated with the page
8
- */
9
- configs?: Array<string>;
10
- /**
11
- * The url to be associated with the page
12
- */
13
- urlPath?: string;
14
- };
@@ -1,10 +0,0 @@
1
- export declare type UpdateProjectParams = {
2
- /**
3
- * Project title
4
- */
5
- name: string;
6
- /**
7
- * Project workers
8
- */
9
- workers: Array<string>;
10
- };