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

Commit

Permalink
Merge pull request #240 from Cloud-Code-AI/238-add-support-for-github…
Browse files Browse the repository at this point in the history
…-pages

updated docs version
  • Loading branch information
sauravpanda authored Dec 25, 2024
2 parents ee37f4d + 546d40b commit bd0ebc5
Show file tree
Hide file tree
Showing 20 changed files with 805 additions and 115 deletions.
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "akiradocs",
"version": "1.0.47",
"version": "1.0.52",
"private": true,
"scripts": {
"translate": "npm run compile && node scripts/translate.js",
Expand Down
98 changes: 49 additions & 49 deletions docs/public/context/en_docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -358,55 +358,6 @@ Context-aware translations
Technical term preservation
Format maintenance
-------------
[Document: docs/guides/analytics.json]
Title: Analytics Integration
Learn how to add analytics tracking to your documentation
AkiraDocs supports Google Analytics 4 (GA4) out of the box. This guide will help you set up analytics tracking for your documentation.
Setting up Google Analytics
1. Create a Google Analytics 4 property in your [Google Analytics account](https://analytics.google.com/)
2. Get your Measurement ID (starts with "G-")
3. Add the ID to your `akiradocs.config.json`:
Code example:
{
"analytics": {
"google": {
"measurementId": "G-XXXXXXXXXX",
"enabled": true
},
"debug": false
}
}
What's Tracked Automatically
Page views
Navigation between pages
Time on page
User language preferences
Device and browser information
Custom Event Tracking
You can track custom events using the `useAnalytics` hook:
Code example:
import { useAnalytics } from '@/hooks/useAnalytics'
function MyComponent() {
const { track } = useAnalytics()
const handleClick = () => {
track('doc_rating', {
rating: 5,
page: 'getting-started',
helpful: true
})
}
return <button onClick={handleClick}>This was helpful</button>
}
Debug Mode
Enable debug mode to see analytics events in the console during development:
Code example:
{
"analytics": {
"debug": true
}
}
This provides a complete analytics integration that's easy for users to set up and extend as needed.
-------------
[Document: docs/installation/troubleshooting.json]
Title: Troubleshooting Guide
Common issues and their solutions when setting up AkiraDocs.
Expand Down Expand Up @@ -630,6 +581,55 @@ Code example:
},
}
-------------
[Document: docs/guides/analytics.json]
Title: Analytics Integration
Learn how to add analytics tracking to your documentation
AkiraDocs supports Google Analytics 4 (GA4) out of the box. This guide will help you set up analytics tracking for your documentation.
Setting up Google Analytics
1. Create a Google Analytics 4 property in your [Google Analytics account](https://analytics.google.com/)
2. Get your Measurement ID (starts with "G-")
3. Add the ID to your `akiradocs.config.json`:
Code example:
{
"analytics": {
"google": {
"measurementId": "G-XXXXXXXXXX",
"enabled": true
},
"debug": false
}
}
What's Tracked Automatically
Page views
Navigation between pages
Time on page
User language preferences
Device and browser information
Custom Event Tracking
You can track custom events using the `useAnalytics` hook:
Code example:
import { useAnalytics } from '@/hooks/useAnalytics'
function MyComponent() {
const { track } = useAnalytics()
const handleClick = () => {
track('doc_rating', {
rating: 5,
page: 'getting-started',
helpful: true
})
}
return <button onClick={handleClick}>This was helpful</button>
}
Debug Mode
Enable debug mode to see analytics events in the console during development:
Code example:
{
"analytics": {
"debug": true
}
}
This provides a complete analytics integration that's easy for users to set up and extend as needed.
-------------
[Document: docs/getting-started/requirements.json]
Title: System Requirements
Before installing AkiraDocs, ensure your environment meets the following requirements.
Expand Down
Loading

0 comments on commit bd0ebc5

Please sign in to comment.