Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

feat: added static build for docs pages #154

Merged
merged 2 commits into from
Dec 1, 2024
Merged

feat: added static build for docs pages #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1debbd1
feat: added static build for docs pages
sauravpanda Dec 1, 2024
c74ee93
updated teh url
sauravpanda Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
<h1 align="center">AkiraDocs</h1>
</p>

<p align="center">
<a href="https://discord.gg/zvYZukgeH2">
<img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
</a>
</p>

<p align="center">
<h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
</p>
Expand Down Expand Up @@ -40,15 +46,32 @@ Or via CLI:
npx create-akiradocs <optional folder name>
```

![AkiraDocs installation](gifs/install_akiradocs.gif)

## 🎯 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

### Notion-like Editor
Intuitive block-based interface with real-time preview

![AkiraDocs editor](gifs/akiradocs_editor.gif)

### AI-Powered Content Generation
Automatically enhance your content with AI

![AkiraDocs AI](gifs/ai_rewrites.gif)

### Translation
Translate your content to multiple languages with AI

![AkiraDocs Translation](gifs/translate.gif)

### 🔍 AI-Generated SEO Optimization
- Automatically optimize your documentation for search engines with AI-driven SEO
Automatically optimize your documentation for search engines with AI-driven SEO
- Improve discoverability and reach without manual SEO adjustments
- AI recommendations for keywords and metadata

Expand All @@ -64,11 +87,6 @@ npx create-akiradocs <optional folder name>
- Rich media support
- Reusable content blocks

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

## 🌍 Going Global
Built-in AI-powered translation. Just add API keys:
Expand Down
4 changes: 2 additions & 2 deletions docs/akiradocs.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"url": "https://docs.akiradocs.com",
"site": {
"title": "Akira Docs",
"description": "Next-gen documentation powered by AI"
"description": "Next-gen documentation powered by AI",
"url": "https://docs.akiradocs.com"
Copy link
Contributor

@kaizen-bot kaizen-bot bot Dec 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment: Use of hardcoded URLs in configuration files.

Solution: Consider using environment variables for URLs to enhance configurability.
!! Make sure the following suggestion is correct before committing it !!

Suggested change
"url": "https://docs.akiradocs.com"
"url": process.env.DOCS_URL || "https://docs.akiradocs.com"

},
"branding": {
"logo": {
Expand Down
1 change: 1 addition & 0 deletions docs/example.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ANTHROPIC_API_KEY=
Copy link
Contributor

@kaizen-bot kaizen-bot bot Dec 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment: Potential exposure of sensitive information in environment files.

Solution: Ensure that .env files are included in .gitignore and provide a sample .env.example file instead.
!! Make sure the following suggestion is correct before committing it !!

Suggested change
ANTHROPIC_API_KEY=
# ANTHROPIC_API_KEY= # Add your API key here

Binary file added docs/gifs/ai_rewrites.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gifs/akiradocs_editor.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gifs/install_akiradocs.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gifs/translate.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "akiradocs",
"version": "1.0.37",
"version": "1.0.38",
"private": true,
"scripts": {
"translate": "npm run compile && node scripts/translate.js",
Expand Down
Loading
Loading