@aigne/doc-smith 0.8.10-beta.3 → 0.8.11-beta

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 (8) hide show
  1. package/.github/workflows/create-release-pr.yaml +21 -0
  2. package/.github/workflows/release.yml +3 -7
  3. package/.release-please-manifest.json +1 -1
  4. package/CHANGELOG.md +15 -0
  5. package/README.md +202 -141
  6. package/RELEASE.md +1 -2
  7. package/package.json +1 -1
  8. package/release-please-config.json +11 -4
package/.github/workflows/create-release-pr.yaml ADDED
@@ -0,0 +1,21 @@
1
+ name: Create Release PR
2
+
3
+ env:
4
+ NODE_OPTIONS: "--max_old_space_size=6144"
5
+
6
+ on:
7
+ workflow_dispatch:
8
+
9
+ permissions:
10
+ contents: write
11
+ pull-requests: write
12
+
13
+ jobs:
14
+ release:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: AIGNE-io/release-please-action@v4.3.0
18
+ id: release
19
+ with:
20
+ token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
21
+ release-stable: true
package/.github/workflows/release.yml CHANGED
@@ -13,7 +13,7 @@ jobs:
13
13
  release-please:
14
14
  runs-on: ubuntu-latest
15
15
  steps:
16
- - uses: googleapis/release-please-action@v4
16
+ - uses: AIGNE-io/release-please-action@v4.3.0
17
17
  id: release
18
18
  with:
19
19
  token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
@@ -45,9 +45,5 @@ jobs:
45
45
  if: ${{ steps.release.outputs.release_created }}
46
46
  run: |
47
47
  npm config set '//registry.npmjs.org/:_authToken' "${{ secrets.NPM_TOKEN }}"
48
- if [[ "${{ steps.release.outputs.version }}" == *beta* ]]; then
49
- pnpm publish --access public --no-git-checks --tag beta
50
- else
51
- pnpm publish --access public --no-git-checks
52
- fi
53
-
48
+ TAG=$(node -p "require(\"./package.json\").version.includes(\"beta\") ? \"beta\" : \"latest\"")
49
+ pnpm publish --access public --no-git-checks --tag $TAG || true
package/.release-please-manifest.json CHANGED
@@ -1,3 +1,3 @@
1
1
  {
2
- ".": "0.8.10-beta.3"
2
+ ".": "0.8.10"
3
3
  }
package/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.8.11-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.10...v0.8.11-beta) (2025-09-22)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * update readme docs ([#130](https://github.com/AIGNE-io/aigne-doc-smith/issues/130)) ([16b5acf](https://github.com/AIGNE-io/aigne-doc-smith/commit/16b5acf2398ee7b242c5f3229f2bcf2de2fad7d0))
9
+
10
+ ## [0.8.10](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.10-beta.3...v0.8.10) (2025-09-20)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * release 0.8.10 ([35ac7c8](https://github.com/AIGNE-io/aigne-doc-smith/commit/35ac7c8fb56d6612595af1429ccad1b7804edeb8))
16
+ * release 0.8.10 ([59c98bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/59c98bbc479cd415c6540ee138e4e711c8dc0490))
17
+
3
18
  ## [0.8.10-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.10-beta.2...v0.8.10-beta.3) (2025-09-19)
4
19
 
5
20
 
package/README.md CHANGED
@@ -1,11 +1,23 @@
1
- [![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-doc-smith?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-doc-smith)
1
+ [![GitHub stars](https://img.shields.io/github/stars/AIGNE-io/aigne-doc-smith?style=flat-square)](https://github.com/AIGNE-io/aigne-doc-smith/stargazers)
2
+ [![NPM Version](https://img.shields.io/npm/v/@aigne/doc-smith?style=flat-square)](https://www.npmjs.com/package/@aigne/doc-smith)
3
+ [![NPM Downloads](https://img.shields.io/npm/dm/@aigne/doc-smith?style=flat-square)](https://www.npmjs.com/package/@aigne/doc-smith)
2
4
  [![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-doc-smith?style=flat-square)](https://github.com/AIGNE-io/aigne-doc-smith/issues)
5
+ [![License](https://img.shields.io/github/license/AIGNE-io/aigne-doc-smith?style=flat-square)](https://github.com/AIGNE-io/aigne-doc-smith/blob/main/LICENSE)
3
6
  [![codecov](https://codecov.io/gh/AIGNE-io/aigne-doc-smith/graph/badge.svg?token=95TQO2NKYC)](https://codecov.io/gh/AIGNE-io/aigne-doc-smith)
4
- [![NPM Version](https://img.shields.io/npm/v/@aigne/doc-smith)](https://www.npmjs.com/package/@aigne/doc-smith)
5
7
 
6
8
  # AIGNE DocSmith
7
9
 
8
- AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
10
+ > 🚀 **AI-powered documentation generation that understands your code**
11
+
12
+ AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automatically analyzes your codebase and generates comprehensive, structured, and multi-language documentation that stays in sync with your code.
13
+
14
+ ## 🎯 Why DocSmith?
15
+
16
+ - **🧠 Intelligent Analysis**: Understands your code structure, patterns, and intent
17
+ - **📚 Comprehensive Coverage**: Generates complete documentation from API references to user guides
18
+ - **🌍 Global Ready**: Supports 12 languages with professional translation
19
+ - **🔄 Always Current**: Automatically detects changes and updates documentation
20
+ - **⚡ Zero Config**: Works out of the box with smart defaults and auto-detection
9
21
 
10
22
  ## AIGNE Ecosystem
11
23
 
@@ -15,22 +27,34 @@ DocSmith is part of the [AIGNE](https://www.aigne.io) ecosystem, a comprehensive
15
27
 
16
28
  As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https://www.aigne.io) components, leveraging the platform's AI capabilities and infrastructure.
17
29
 
18
- ## Features
30
+ ## ✨ Features
31
+
32
+ ### 🤖 AI-Powered Generation
33
+ - **Smart Structure Planning**: Automatically analyzes your codebase to create logical, comprehensive documentation structure
34
+ - **Intelligent Content Creation**: Generates detailed, contextual content that explains both "what" and "why"
35
+ - **Adaptive Writing Styles**: Supports multiple documentation styles (Technical, User-Friendly, Developer-Focused, etc.)
19
36
 
20
- - **Automated Document Structure Generation:** Intelligently analyzes your codebase to generate a comprehensive and logical document structure.
21
- - **AI-Powered Content Generation:** Populates the document structure with detailed, high-quality content.
22
- - **Multi-Language Support:** Seamlessly translates your documentation into 12 languages including English, Chinese, Japanese, Korean, Spanish, French, German, Portuguese, Russian, Italian, and Arabic.
23
- - **AIGNE Hub Integration:** Use [AIGNE Hub](https://www.aigne.io/en/hub) as your LLM provider without needing your own API keys, with easy switching between different large language models.
24
- - **Document Publishing:** Preview your documentation on the official platform at [docsmith.aigne.io](https://docsmith.aigne.io/app/), or publish to your own [Discuss Kit](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) instance for full control.
25
- - **Document Update Mechanism:** Automatically detects source code changes and updates documentation accordingly.
26
- - **Individual Document Optimization:** Regenerate and optimize specific documents with targeted feedback.
37
+ ### 🌍 Multi-Language Excellence
38
+ - **12 Language Support**: English, Chinese (Simplified & Traditional), Japanese, Korean, Spanish, French, German, Portuguese, Russian, Italian, and Arabic
39
+ - **Professional Translation**: Context-aware translation that maintains technical accuracy
40
+ - **Glossary Integration**: Consistent terminology across all languages
27
41
 
28
- ## Getting Started
42
+ ### 🔗 Seamless Integration
43
+ - **AIGNE Hub Integration**: Use [AIGNE Hub](https://www.aigne.io/en/hub) without API keys, switch between Google Gemini, OpenAI GPT, Claude, and more
44
+ - **Multiple LLM Support**: Bring your own API keys for OpenAI, Anthropic, Google, and other providers
45
+ - **Discuss Kit Publishing**: Deploy to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) instance
46
+
47
+ ### 🔄 Smart Updates
48
+ - **Change Detection**: Automatically identifies code changes and updates relevant documentation
49
+ - **Targeted Regeneration**: Update specific sections with custom feedback and requirements
50
+ - **Version Awareness**: Maintains documentation history and tracks changes over time
51
+
52
+ ## 🚀 Quick Start
29
53
 
30
54
  ### Prerequisites
31
55
 
32
- - Node.js and npm
33
- - AIGNE CLI
56
+ - Node.js 18+ and npm/pnpm
57
+ - No API keys required (uses AIGNE Hub by default)
34
58
 
35
59
  ### Node.js Installation
36
60
 
@@ -104,210 +128,247 @@ node --version
104
128
  npm --version
105
129
  ```
106
130
 
107
- ### Installation
131
+ ### 📦 Installation
108
132
 
109
- Install the latest version of AIGNE CLI globally:
133
+ Install the AIGNE CLI globally:
110
134
 
111
135
  ```bash
112
- npm i -g @aigne/cli
136
+ npm install -g @aigne/cli
113
137
  ```
114
138
 
115
139
  Verify the installation:
116
140
 
117
141
  ```bash
118
- aigne doc -h
142
+ aigne doc --help
119
143
  ```
120
144
 
121
- That's it! You can now use DocSmith directly through the AIGNE CLI.
122
-
123
- ### LLM Configuration
124
-
125
- DocSmith supports multiple LLM providers through AIGNE Hub:
145
+ ### 🎉 Generate Your First Documentation
126
146
 
127
- - **AIGNE Hub (Recommended):** No API key required, easy model switching
128
- - **Custom API Keys:** Support for OpenAI, Anthropic, and other providers
129
-
130
- To use AIGNE Hub, simply run commands without specifying API keys:
147
+ Navigate to your project directory and run:
131
148
 
132
149
  ```bash
133
- # Using AIGNE Hub with different models
134
- aigne doc generate --model google:gemini-2.5-flash
135
- aigne doc generate --model claude:claude-3-5-sonnet
136
- aigne doc generate --model openai:gpt-4o
150
+ # One command to rule them all
151
+ aigne doc generate
137
152
  ```
138
153
 
139
- ### Usage
154
+ DocSmith will:
155
+ 1. 🔍 Auto-detect your project structure and tech stack
156
+ 2. 🎯 Guide you through an interactive setup (first time only)
157
+ 3. 📝 Generate comprehensive documentation
158
+ 4. 🌍 Optionally translate to multiple languages
159
+ 5. 🚀 Publish to your preferred platform
140
160
 
141
- #### Generate Documentation
161
+ ## 🔧 Advanced Configuration
142
162
 
143
- To generate documentation, simply run:
144
-
145
- ```bash
146
- aigne doc generate
147
- ```
163
+ ### LLM Providers
148
164
 
149
- **Smart Auto-Configuration:** If you haven't run `init` before, DocSmith will automatically detect this and guide you through the interactive configuration wizard first. This includes:
150
- - Document generation rules and style selection
151
- - Target audience definition
152
- - Primary and translation language settings
153
- - Source code path configuration
154
- - Output directory setup
165
+ DocSmith supports multiple AI providers:
155
166
 
156
- **Force Regeneration:** To regenerate all documentation from scratch, use:
167
+ **🎯 AIGNE Hub (Recommended)**
168
+ - ✅ No API keys required
169
+ - ✅ Easy model switching
170
+ - ✅ Built-in rate limiting and optimization
157
171
 
158
172
  ```bash
159
- aigne doc generate --forceRegenerate
173
+ # Switch models effortlessly
174
+ aigne doc generate --model google:gemini-2.5-pro
175
+ aigne doc generate --model claude:claude-3-5-sonnet
176
+ aigne doc generate --model openai:gpt-4o
160
177
  ```
161
178
 
162
- This will regenerate all documentation based on the latest source code and configuration.
179
+ **🔑 Custom API Keys**
180
+ Configure your own API keys for direct provider access:
181
+ - OpenAI GPT models
182
+ - Anthropic Claude models
183
+ - Google Gemini models
184
+ - And more...
163
185
 
164
- #### Manual Configuration (Optional)
186
+ ## 📖 Usage Guide
165
187
 
166
- If you prefer to set up configuration manually or want to modify existing settings:
188
+ ### Core Commands
167
189
 
190
+ #### 📝 Generate Documentation
168
191
  ```bash
169
- aigne doc init
170
- ```
171
-
172
- This will start the interactive configuration wizard directly.
192
+ # Smart generation with auto-configuration
193
+ aigne doc generate
173
194
 
174
- #### Update Individual Documents
195
+ # Force complete regeneration
196
+ aigne doc generate --forceRegenerate
175
197
 
176
- Optimize specific documents with targeted feedback:
198
+ # Generate with custom feedback
199
+ aigne doc generate --feedback "Add more API examples and troubleshooting sections"
200
+ ```
177
201
 
202
+ #### 🔄 Update Existing Documents
178
203
  ```bash
179
204
  # Interactive document selection and update
180
205
  aigne doc update
181
206
 
182
- # Update a specific document
183
- aigne doc update --docs overview.md --feedback "Add more comprehensive FAQ entries"
207
+ # Update specific document with feedback
208
+ aigne doc update --docs overview.md --feedback "Add comprehensive FAQ section"
184
209
  ```
185
210
 
186
- **Interactive Mode:** When run without parameters, `aigne doc update` will present an interactive menu for you to select which document to regenerate and provide feedback.
211
+ #### 🌍 Multi-Language Translation
212
+ ```bash
213
+ # Interactive translation with smart language selection
214
+ aigne doc translate
187
215
 
188
- #### Optimize Document Structure
216
+ # Translate specific documents to multiple languages
217
+ aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
189
218
 
190
- Improve the overall documentation structure based on feedback:
219
+ # Translation with custom glossary for consistent terminology
220
+ aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently"
221
+ ```
191
222
 
223
+ #### 🚀 Publishing & Deployment
192
224
  ```bash
193
- # Optimize structure with feedback
194
- aigne doc generate --feedback "Remove About section and add API Reference"
225
+ # Interactive publishing with platform selection
226
+ aigne doc publish
195
227
 
196
- # Regenerate structure with specific improvements
197
- aigne doc generate --feedback "Add more detailed installation guide and troubleshooting section"
228
+ # Publish to custom Discuss Kit instance
229
+ aigne doc publish --appUrl https://your-discuss-kit-instance.com
198
230
  ```
199
231
 
200
- **Structure Optimization:** Use `aigne doc generate` with `--feedback` to refine the overall documentation structure, add new sections, or reorganize existing content.
232
+ #### ⚙️ Configuration Management
233
+ ```bash
234
+ # Interactive configuration setup
235
+ aigne doc init
201
236
 
202
- #### Document Translation
237
+ # View current configuration
238
+ aigne doc prefs
239
+ ```
203
240
 
204
- Translate existing documentation to multiple languages:
241
+ ### Configuration Options
205
242
 
206
- ```bash
207
- # Translate specific documents to multiple languages
208
- aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
243
+ DocSmith automatically detects your project structure, but you can customize:
209
244
 
210
- # Interactive translation with document and language selection
211
- aigne doc translate
212
- ```
245
+ - **📝 Documentation Styles**: Technical, User-Friendly, Developer-Focused, Academic
246
+ - **🎯 Target Audiences**: Developers, End Users, System Administrators, Business Users
247
+ - **🌍 Languages**: Choose from 12 supported languages
248
+ - **📁 Source Paths**: Customize which files and directories to analyze
249
+ - **📤 Output Settings**: Configure documentation structure and formatting
213
250
 
214
- **Command Parameters:**
215
- - `--langs`: Specify target languages (can be used multiple times)
216
- - `--docs`: Specify document paths to translate (can be used multiple times)
217
- - `--feedback`: Provide feedback for translation improvement
218
- - `--glossary`: Use a glossary file for consistent terminology (@path/to/glossary.md)
219
251
 
220
- **Interactive Mode:** When run without parameters, `aigne doc translate` will present interactive menus to:
221
- - Select documents to translate from your documentation
222
- - Choose target languages from 12 supported languages
223
- - Add new translation languages to your configuration
224
252
 
225
- #### Publishing to Discuss Kit
253
+ ## 🌐 Supported Languages
226
254
 
227
- Publish your documentation to Discuss Kit platforms:
255
+ DocSmith provides professional translation for 12 languages:
228
256
 
229
- ```bash
230
- # Interactive publishing with platform selection
231
- aigne doc publish
232
- ```
257
+ | Language | Code | Support Level |
258
+ |----------|------|---------------|
259
+ | English | `en` | ✅ Native |
260
+ | 简体中文 | `zh-CN` | ✅ Full |
261
+ | 繁體中文 | `zh-TW` | ✅ Full |
262
+ | 日本語 | `ja` | ✅ Full |
263
+ | 한국어 | `ko` | ✅ Full |
264
+ | Español | `es` | ✅ Full |
265
+ | Français | `fr` | ✅ Full |
266
+ | Deutsch | `de` | ✅ Full |
267
+ | Português | `pt-BR` | ✅ Full |
268
+ | Русский | `ru` | ✅ Full |
269
+ | Italiano | `it` | ✅ Full |
270
+ | العربية | `ar` | ✅ Full |
233
271
 
234
- **Interactive Publishing:** When you run `aigne doc publish`, it will present an interactive menu for you to choose between:
235
- - **Official Platform:** [docsmith.aigne.io](https://docsmith.aigne.io/app/)
236
- - **Own Instance:** Your own deployed [Discuss Kit](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) instance
237
272
 
273
+ ## 🤝 Contributing
238
274
 
275
+ We welcome contributions from the community! Here's how you can help:
239
276
 
240
- ## Supported Languages
277
+ ### 🐛 Reporting Issues
278
+ - 🔍 [Search existing issues](https://github.com/AIGNE-io/aigne-doc-smith/issues) first
279
+ - 📝 Use our issue templates for bug reports and feature requests
280
+ - 🚨 Include clear reproduction steps and environment details
241
281
 
242
- DocSmith supports 12 languages with automatic translation:
282
+ ### 💡 Feature Requests
283
+ - 🌟 Share your ideas in [GitHub Discussions](https://github.com/AIGNE-io/aigne-doc-smith/discussions)
284
+ - 📋 Check our [roadmap](https://github.com/AIGNE-io/aigne-doc-smith/projects) for planned features
285
+ - 🗳️ Vote on existing feature requests
243
286
 
244
- - English (en)
245
- - 简体中文 (zh-CN)
246
- - 繁體中文 (zh-TW)
247
- - 日本語 (ja)
248
- - 한국어 (ko)
249
- - Español (es)
250
- - Français (fr)
251
- - Deutsch (de)
252
- - Português (pt-BR)
253
- - Русский (ru)
254
- - Italiano (it)
255
- - العربية (ar)
287
+ ### 🔧 Development Setup
288
+ ```bash
289
+ # Clone the repository
290
+ git clone https://github.com/AIGNE-io/aigne-doc-smith.git
291
+ cd aigne-doc-smith
256
292
 
293
+ # Install dependencies
294
+ pnpm install
257
295
 
258
- ## Contributing
296
+ # Run tests
297
+ pnpm test
259
298
 
260
- Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or find any bugs.
299
+ # Run linting
300
+ pnpm run lint
261
301
 
262
- ## Command Examples
302
+ # Auto fix lint error
303
+ pnpm run lint:fix
304
+ ```
263
305
 
264
- ### Basic Usage
306
+ ### 📜 Code of Conduct
307
+ Please read our [Code of Conduct](https://github.com/AIGNE-io/aigne-doc-smith/blob/main/CODE_OF_CONDUCT.md) before contributing.
265
308
 
266
- ```shell
267
- # Interactive setup and configuration
268
- aigne doc init
309
+ ## 💼 Enterprise & Production Use
269
310
 
270
- # Generate documentation with default settings
271
- aigne doc generate
311
+ ### 🏢 Enterprise Features
312
+ - **Team Collaboration**: Multi-user workflows with role-based access
313
+ - **Custom Branding**: White-label documentation with your brand identity
314
+ - **API Integration**: REST APIs for automated documentation pipelines
315
+ - **Analytics**: Track documentation usage and effectiveness
272
316
 
273
- # Generate with specific model
274
- aigne doc generate --model google:gemini-2.5-flash
317
+ ### 🔒 Security & Compliance
318
+ - **Private Cloud**: Deploy on your own infrastructure
319
+ - **SSO Integration**: Connect with your identity providers
320
+ - **Audit Logs**: Complete activity tracking and compliance reporting
321
+ - **Data Privacy**: Your code never leaves your environment in private deployments
275
322
 
276
- # Force regenerate all documentation from scratch
277
- aigne doc generate --forceRegenerate
278
- ```
323
+ ### 📞 Support & Services
324
+ - **Priority Support**: Direct access to our engineering team
325
+ - **Custom Training**: Team onboarding and best practices workshops
326
+ - **Professional Services**: Custom integrations and deployment assistance
279
327
 
280
- ### Advanced Usage
328
+ [Contact us](https://www.aigne.io/contact) for enterprise licensing and deployment options.
281
329
 
282
- ```shell
283
- # Update structure with feedback
284
- aigne doc generate --feedback "Remove About section and add API Reference"
330
+ ## 📊 Community & Resources
285
331
 
286
- # Update specific document
287
- aigne doc update --doc-path /faq --feedback "Add more comprehensive FAQ entries"
332
+ ### 📚 Documentation & Tutorials
333
+ - 📖 [Official Documentation](https://docsmith.aigne.io/docs/)
334
+ - 🎥 [Video Tutorials](https://www.youtube.com/@aigne-io)
335
+ - 📝 [Best Practices Guide](https://docsmith.aigne.io/guides/best-practices)
336
+ - 🔧 [API Reference](https://docsmith.aigne.io/api/)
288
337
 
289
- # Translate documents to multiple languages
290
- aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
338
+ ### 💬 Community Support
339
+ - 💭 [GitHub Discussions](https://github.com/AIGNE-io/aigne-doc-smith/discussions) - Q&A and feature discussions
340
+ - 🐦 [Twitter](https://twitter.com/aigne_io) - Updates and announcements
341
+ - 🎮 [Discord Server](https://discord.gg/aigne) - Real-time community chat
342
+ - 📧 [Newsletter](https://www.aigne.io/newsletter) - Monthly updates and tips
291
343
 
292
- # Interactive translation (select documents and languages)
293
- aigne doc translate
344
+ ### 🏆 Showcase
345
+ See DocSmith in action with real-world examples:
346
+ - [AIGNE Framework Docs](https://docs.aigne.io) - Generated with DocSmith
347
+ - [Community Projects](https://github.com/topics/aigne-docsmith) - Browse repositories using DocSmith
294
348
 
295
- # Translate with custom glossary and feedback
296
- aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently"
297
- ```
349
+ ## 📄 License
298
350
 
299
- ### Publishing and Integration
351
+ This project is licensed under the **Elastic License 2.0** - see the [LICENSE](LICENSE) file for details.
300
352
 
301
- ```shell
302
- # Interactive publishing with platform selection
303
- aigne doc publish
353
+ ### What does this mean?
354
+ - ✅ **Free for most use cases**: Personal projects, internal use, and most commercial applications
355
+ - ✅ **Open source**: Full source code available for review and contributions
356
+ - ✅ **Commercial friendly**: Use in your business applications and services
357
+ - ❌ **Restrictions**: Cannot offer DocSmith as a competing hosted service
304
358
 
305
- # Publish to custom Discuss Kit instance
306
- aigne doc publish --appUrl https://your-discuss-kit-instance.com
359
+ [Learn more about Elastic License 2.0](https://www.elastic.co/licensing/elastic-license)
307
360
 
361
+ ---
308
362
 
309
- ```
363
+ <div align="center">
364
+
365
+ **🚀 Start generating amazing documentation today!**
366
+
367
+ [![Get Started](https://img.shields.io/badge/Get_Started-brightgreen?style=for-the-badge&logo=rocket)](https://docsmith.aigne.io/get-started)
368
+ [![Join Community](https://img.shields.io/badge/Join_Community-blue?style=for-the-badge&logo=discord)](https://discord.gg/aigne)
369
+ [![Star on GitHub](https://img.shields.io/badge/Star_on_GitHub-yellow?style=for-the-badge&logo=github)](https://github.com/AIGNE-io/aigne-doc-smith)
370
+
371
+ Made with ❤️ by the [AIGNE Team](https://www.aigne.io/team)
310
372
 
311
- ## License
373
+ </div>
312
374
 
313
- This project is licensed under the Elastic License 2.0 License - see the [LICENSE](LICENSE) file for details.
package/RELEASE.md CHANGED
@@ -5,6 +5,5 @@ Merge that PR when appropriate.
5
5
 
6
6
  ### Release a prod version
7
7
 
8
- When you want to publish a production version, you can run `git commit --allow-empty -m "chore: release x.x.x" -m "Release-As: x.x.x"` to main.
9
- release-please will update the PR to release to a specific version (without beta).
8
+ When you want publish a prod version, manually execute the GitHub Action 'Create Release PR' to create a release PR for the prod version.
10
9
  Merge that PR when appropriate.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aigne/doc-smith",
3
- "version": "0.8.10-beta.3",
3
+ "version": "0.8.11-beta",
4
4
  "description": "AI-driven documentation generation tool built on the AIGNE Framework",
5
5
  "publishConfig": {
6
6
  "access": "public"
package/release-please-config.json CHANGED
@@ -1,13 +1,20 @@
1
1
  {
2
2
  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
3
+ "release-type": "node",
4
+ "prerelease": true,
5
+ "versioning": "prerelease",
3
6
  "packages": {
4
7
  ".": {
5
- "release-type": "node",
6
8
  "bump-minor-pre-major": true,
7
9
  "bump-patch-for-minor-pre-major": true,
8
10
  "include-component-in-tag": false,
9
- "prerelease-type": "beta",
10
- "versioning": "prerelease"
11
+ "prerelease-type": "beta"
11
12
  }
12
- }
13
+ },
14
+ "plugins": [
15
+ {
16
+ "type": "node-workspace",
17
+ "updatePeerDependencies": true
18
+ }
19
+ ]
13
20
  }