Skip to content

Commit

Permalink
Merge pull request #134 from Cloud-Code-AI/newversion-create-app
Browse files Browse the repository at this point in the history
Updated readme and template trigger
  • Loading branch information
sauravpanda authored Nov 28, 2024
2 parents ede19f8 + 9515e1e commit e1ef7bf
Show file tree
Hide file tree
Showing 9 changed files with 251 additions and 118 deletions.
24 changes: 10 additions & 14 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
## Description
<!-- Describe your changes in detail -->
## 🔍 Description
<!-- What does this PR do? -->

## Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
## Type
- [ ] 🐛 Bug Fix
- [ ] ✨ Feature
- [ ] 📚 Documentation
- [ ] 🔧 Other: _____

## Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Tested locally
- [ ] Updated docs (if needed)
- [ ] Added/updated tests (if needed)
58 changes: 58 additions & 0 deletions .github/workflows/update-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Trigger Template Repository Update

on:
push:
branches:
- main
paths:
- 'packages/create-app/package.json'

jobs:
trigger-update:
runs-on: ubuntu-latest
permissions:
contents: write
actions: write

steps:
- uses: actions/checkout@v4

- name: Extract Package Version
id: get-version
run: |
VERSION=$(jq -r .version packages/create-app/package.json)
echo "version=$VERSION" >> $GITHUB_OUTPUT
- name: Check Latest Release
id: check-release
run: |
LATEST_RELEASE=$(curl -s https://api.github.com/repos/${{ github.repository }}/releases/latest | jq -r .tag_name | sed 's/^v//')
CURRENT_VERSION=${{ steps.get-version.outputs.version }}
if [ "$LATEST_RELEASE" == "$CURRENT_VERSION" ]; then
echo "No version change detected. Skipping release."
echo "skip=true" >> $GITHUB_OUTPUT
else
echo "New version detected. Proceeding with release."
echo "skip=false" >> $GITHUB_OUTPUT
fi
- name: Create Release
if: steps.check-release.outputs.skip != 'true'
uses: softprops/action-gh-release@v1
with:
tag_name: v${{ steps.get-version.outputs.version }}
name: Release v${{ steps.get-version.outputs.version }}
draft: false
prerelease: false
generate_release_notes: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Repository Dispatch
if: steps.check-release.outputs.skip != 'true'
uses: peter-evans/repository-dispatch@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository_owner }}/akiradocs-template
event-type: update-template
client-payload: '{"ref": "${{ github.ref }}","sha": "${{ github.sha }}","version": "${{ steps.get-version.outputs.version }}"}'
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,5 @@ template/

*node_modules*

million/
wrangler/
145 changes: 65 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,110 +1,95 @@
# AkiraDocs

**Smart documentation platform with AI at its core**
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Demo Live](https://img.shields.io/badge/Demo-Live-color.svg)](https://demo.akiradocs.ai)
[![Join Waitlist](https://img.shields.io/badge/Join-Waitlist-orange.svg)](https://forms.gle/KunU4BGhToH4NJ1t7)
<p align="center">
If you find AkiraDocs useful, please consider giving it a star! ⭐️<br>
Your support helps us continue improving the platform.
</p>

## 🚀 Get Started
To create a new AkiraDocs project using the OSS template, run:
<p align="center">
<img src="gifs/star_the_repo.gif" alt="Star the Repo" width="100%">
</p>

```bash
npx create-akiradocs <optional folder name>
```

## 🎯 Why Choose AkiraDocs?
- **For Developers**:
- Keep your existing Markdown/Git workflow
- Full Markdown/MDX support
- Easy custom component development

- **For Content Teams**:
- User-friendly WYSIWYG editor
- Real-time previews, no coding required

- **For Enterprises**:
- SSO/SAML integration
- Audit logs and custom deployment options

## 😟 Common Documentation Challenges
- Keeping documentation in sync across teams
- Managing multiple versions of documents
- Needing better analytics for documentation usage

## 🎭 Use Cases
- **Developer Documentation**: API references, SDK guides, implementation examples.
- **Product Documentation**: User guides, release notes, tutorials.
- **Enterprise Knowledge**: Internal wikis, process documentation.

## 🚀 Migrate Existing Docs (Coming Soon)
Easily bring your documentation from various sources:

```bash
npx akiradocs-migrate import --from=source --to=mydocs
## **Smart documentation platform with AI at its core**

Supported sources:
✓ Markdown/MDX files
✓ GitBook
✓ Docusaurus
✓ ReadTheDocs
✓ Confluence
✓ Notion
```

## 📄 SEO Optimized by Default
Every page is automatically optimized for search engines:
- SEO-friendly URLs and auto-generated meta tags
- Mobile-first indexing and fast performance
<p align="center">
<a href="https://demo.akiradocs.ai">
<img src="https://img.shields.io/badge/Try_Demo-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Live Demo">
</a>
<a href="https://forms.gle/KunU4BGhToH4NJ1t7">
<img src="https://img.shields.io/badge/Join_Waitlist_For_Cloud_Hosting-FF6B6B?style=for-the-badge&logo=googleforms&logoColor=white" alt="Join Waitlist for Cloud Hosting">
</a>
</p>

## ✍️ Modern Block-Based Editor
Create documentation with ease:
- Rich text blocks, images, diagrams, and code blocks
- Collapsible sections and reusable content blocks
## 🚀 What is AkiraDocs?
AkiraDocs is a modern documentation platform that combines the power of AI with an intuitive authoring experience. Whether you're a developer, content creator, or enterprise team, AkiraDocs provides the tools you need to create, manage, and share documentation effectively.

## 🌐 Multi-Language Support (Coming Soon)
Reach a global audience with:
- AI-powered translation suggestions
- Side-by-side translation editor
## ⚡️ Quick Deploy
Get started in seconds:

## 💪 Setup and Translate
Set up environment variables for translation:
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template)

Or via CLI:
```bash
ANTHROPIC_API_KEY=sk-ant-api03-...
npx create-akiradocs <optional folder name>
```

Configure target languages in `akiradocs.config.json`:

## 🎯 Perfect For
- **Developers**: API docs, SDK guides, implementation examples
- **Product Teams**: User guides, release notes, tutorials
- **Enterprises**: Internal wikis, process documentation, knowledge bases

## ✨ Key Features

### 🛠 Developer-Friendly
- Keep your existing Markdown/Git workflow
- Full Markdown/MDX support
- Easy custom component development
- SEO optimization out of the box

### 📝 Content Creator-Friendly
- Modern block-based WYSIWYG editor
- Real-time previews
- Rich media support
- Reusable content blocks

### 🏢 Enterprise-Ready
- SSO/SAML integration
- Audit logs
- Custom deployment options
- Version control

## 🌍 Going Global (Coming Soon)
Built-in AI-powered translation:
```json
{
"translation": {
"auto_translate": true,
"provider": "anthropic",
"model": "claude-3-sonnet-20240229",
"targetLanguages": ["es", "fr", "de"],
"excludedPaths": ["_meta.json"]
"targetLanguages": ["es", "fr", "de"]
}
}
```

Run the translation command:

## 🔄 Easy Migration (Coming Soon)
Import your existing docs:
```bash
npm run translate
npx akiradocs-migrate import --from=source --to=mydocs
# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion
```

## 📄 Licensing
- **MIT License**: Free for open source and personal projects.
- **Commercial License**: Available for enterprise features.

## 🤝 Join Our Community
- [Live Demo](https://demo.akiradocs.ai)
- [Documentation](https://docs.akiradocs.com)
- [Discord Community](https://discord.gg/zvYZukgeH2)
- [GitHub Discussions](https://github.com/akiradocs/discussions)
- [Documentation](https://docs.akiradocs.com)
- [Join the Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) → Early access to upcoming features
- [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access

## 📄 Licensing
- Open Source (MIT License)
- Commercial License available for enterprise features

---

[Get Started](https://docs.akiradocs.ai/quickstart)
[Live Demo](https://demo.akiradocs.ai)
[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)
[Get Started](https://docs.akiradocs.ai/quickstart)
[Live Demo](https://demo.akiradocs.ai)
[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)
Binary file added gifs/star_the_repo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions packages/akiradocs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Dependencies
/node_modules/
.pnp
.pnp.js
.yarn/install-state.gz

# Build
dist
.next
out

# Testing
coverage

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

.env
.env.local
.env.development.local
.env.test.local
.env.production.local

# IDE
.idea
.vscode
*.sublime-workspace

.turbo/
.next/
**/node_modules/
**/dist/
**/dist/

.DS_Store
Thumbs.db

template/

*node_modules*

million/
wrangler/
3 changes: 2 additions & 1 deletion packages/create-app/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-akiradocs",
"version": "1.0.30",
"version": "1.0.33",
"description": "Create Akira Docs documentation sites with one command",
"main": "./dist/index.js",
"type": "module",
Expand All @@ -21,6 +21,7 @@
"files": [
"dist",
"template",
"editor",
"README.md",
"LICENSE"
],
Expand Down
Loading

0 comments on commit e1ef7bf

Please sign in to comment.