Skip to content

Commit c9b6a84

Browse files
committed
refactor: remove all emojis for professional tone
- Remove emojis from all documentation files - Remove emojis from script files and README - Remove emojis from setup and configuration files - Maintain professional tone throughout codebase - Keep functionality intact while improving readability Files updated: - docs/index.md - docs/architecture/index.md - docs/examples/index.md - docs/setup/index.md - docs/development/git-workflow.md - scripts/sync-docs.sh - scripts/test-sync-setup.sh - scripts/initialize-docs-repo.sh - README.md - DOCS_SYNC_SETUP.md
1 parent 8b23168 commit c9b6a84

10 files changed

Lines changed: 122 additions & 122 deletions

File tree

DOCS_SYNC_SETUP.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
This guide will help you set up automatic synchronization between your main repository's `docs/` directory and a separate `altus4/docs` repository.
44

5-
## 🎯 Overview
5+
## Overview
66

77
The setup creates:
88

9-
- 📁 **Separate docs repository**: `altus4/docs` for documentation only
10-
- 🔄 **Automatic sync**: Changes in `docs/` directory trigger sync to docs repo
11-
- 🚀 **GitHub Pages**: Auto-deployment of documentation site
12-
- 🛠️ **Manual sync**: Script for manual synchronization when needed
9+
- **Separate docs repository**: `altus4/docs` for documentation only
10+
- **Automatic sync**: Changes in `docs/` directory trigger sync to docs repo
11+
- **GitHub Pages**: Auto-deployment of documentation site
12+
- **Manual sync**: Script for manual synchronization when needed
1313

14-
## 📋 Prerequisites
14+
## Prerequisites
1515

1616
1. **GitHub Account** with permissions to create repositories in the `altus4` organization
1717
2. **Git configured** with SSH keys or personal access token
1818
3. **Repository access** to both main and docs repositories
1919

20-
## 🚀 Step-by-Step Setup
20+
## Step-by-Step Setup
2121

2222
### Step 1: Create the Documentation Repository
2323

@@ -27,7 +27,7 @@ The setup creates:
2727
Repository name: altus4/docs
2828
Description: Documentation for Altus 4 - AI-Enhanced MySQL Full-Text Search Engine
2929
Visibility: Public (recommended for GitHub Pages)
30-
Initialize: Add a README file
30+
Initialize: Add a README file
3131
```
3232

3333
2. **Enable GitHub Pages**:
@@ -43,8 +43,8 @@ The setup creates:
4343
- Name: `docs-sync-token`
4444
- Expiration: **No expiration** (or set as needed)
4545
- Scopes:
46-
- `repo` (Full control of private repositories)
47-
- `workflow` (Update GitHub Action workflows)
46+
- `repo` (Full control of private repositories)
47+
- `workflow` (Update GitHub Action workflows)
4848

4949
2. **Copy the token** - you'll need it in the next step
5050

@@ -73,7 +73,7 @@ In your **main repository** (this one):
7373
4. **Verify the docs repository** receives the changes
7474
5. **Check GitHub Pages** deployment (may take a few minutes)
7575

76-
## 🛠️ Manual Sync Options
76+
## Manual Sync Options
7777

7878
### Using npm Scripts
7979

@@ -102,7 +102,7 @@ npm run docs:sync:force
102102
3. Click **Run workflow**
103103
4. Choose branch and optionally force sync
104104

105-
## 📁 Repository Structure
105+
## Repository Structure
106106

107107
After setup, your repositories will look like:
108108

@@ -134,7 +134,7 @@ After setup, your repositories will look like:
134134
└── .gitignore # Docs-specific gitignore
135135
```
136136

137-
## 🔧 Configuration Options
137+
## Configuration Options
138138

139139
### Sync Script Configuration
140140

@@ -164,7 +164,7 @@ on:
164164
- 'README.md' # Also sync README changes
165165
```
166166
167-
## 🔍 Troubleshooting
167+
## Troubleshooting
168168
169169
### Common Issues
170170
@@ -207,16 +207,16 @@ git diff
207207
bash -x scripts/sync-docs.sh
208208
```
209209

210-
## 🎉 Success Indicators
210+
## Success Indicators
211211

212212
When everything is working correctly:
213213

214-
1. **Automatic Sync**: Changes to `docs/` trigger the sync workflow
215-
2. **Docs Repository**: Updated within minutes of main repo changes
216-
3. **GitHub Pages**: Documentation site updates automatically
217-
4. **Manual Sync**: `npm run docs:sync` works without errors
214+
1. **Automatic Sync**: Changes to `docs/` trigger the sync workflow
215+
2. **Docs Repository**: Updated within minutes of main repo changes
216+
3. **GitHub Pages**: Documentation site updates automatically
217+
4. **Manual Sync**: `npm run docs:sync` works without errors
218218

219-
## 📚 Next Steps
219+
## Next Steps
220220

221221
After setup is complete:
222222

@@ -225,7 +225,7 @@ After setup is complete:
225225
3. **Team notification**: Inform team about the new documentation workflow
226226
4. **Monitor**: Check sync status after first few documentation changes
227227

228-
## 🔗 Useful Links
228+
## Useful Links
229229

230230
- **Documentation Site**: <https://altus4.github.io/docs>
231231
- **Docs Repository**: <https://github.com/altus4/docs>

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,19 @@ To update the content:
106106

107107
This project includes comprehensive VitePress documentation that automatically syncs to a separate repository.
108108

109-
### 📚 Documentation Site
109+
### Documentation Site
110110

111111
Live Documentation: [https://altus4.github.io/docs](https://altus4.github.io/docs)
112112

113-
### 🔄 Documentation Sync
113+
### Documentation Sync
114114

115115
The `docs/` directory is automatically synchronized to the [`altus4/docs`](https://github.com/altus4/docs) repository:
116116

117117
- **Automatic**: Triggered on push to `main` or `develop` branches
118118
- **Manual**: Use `npm run docs:sync` for manual synchronization
119119
- **GitHub Pages**: Auto-deployment to documentation site
120120

121-
### 📝 Working with Documentation
121+
### Working with Documentation
122122

123123
```bash
124124
# Start documentation development server
@@ -137,7 +137,7 @@ npm run docs:sync
137137
npm run docs:sync:force
138138
```
139139

140-
### 🛠️ Documentation Setup
140+
### Documentation Setup
141141

142142
For initial setup of the documentation sync system, see [`DOCS_SYNC_SETUP.md`](./DOCS_SYNC_SETUP.md).
143143

docs/architecture/index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Comprehensive documentation of Altus 4's system architecture, desig
88
AI-Enhanced MySQL Search Engine Architecture
99

1010
::: info Sync Test
11-
🧪 **Sync Test**: This documentation was updated on December 2024 to test automatic synchronization from `altus4/website` to `altus4/docs`.
11+
**Sync Test**: This documentation was updated on December 2024 to test automatic synchronization from `altus4/website` to `altus4/docs`.
1212
:::
1313

1414
Altus 4 is built on a modern, scalable architecture that combines traditional database search with AI capabilities. This document covers the system design, patterns, and implementation details.
@@ -42,15 +42,15 @@ graph TD
4242

4343
### Architecture Principles
4444

45-
- **🔄 Layered Design**: Clear separation of concerns
45+
- **Layered Design**: Clear separation of concerns
4646
- **🔌 Dependency Injection**: Loose coupling between components
47-
- **Async Processing**: Non-blocking operations throughout
48-
- **📊 Event-Driven**: Analytics and monitoring via events
49-
- **🔒 Security-First**: Authentication and authorization at every layer
47+
- **Async Processing**: Non-blocking operations throughout
48+
- **Event-Driven**: Analytics and monitoring via events
49+
- **Security-First**: Authentication and authorization at every layer
5050

5151
## Core Components
5252

53-
### 🌐 Client Layer
53+
### Client Layer
5454

5555
User-facing interfaces and integrations
5656

@@ -67,15 +67,15 @@ Request handling and middleware pipeline
6767
::: details API Layer Components
6868

6969
- **🌍 Express.js Server**: RESTful API endpoints with middleware pipeline
70-
- **🔐 Authentication**: API key-based authentication with tiered rate limiting
71-
- **Validation**: Zod schema validation for all endpoints
72-
- **⏱️ Rate Limiting**: Redis-backed rate limiting per API key tier
73-
- **⚠️ Error Handling**: Centralized error handling with structured responses
74-
- **📈 Request Logging**: Comprehensive logging with correlation IDs
70+
- **Authentication**: API key-based authentication with tiered rate limiting
71+
- **Validation**: Zod schema validation for all endpoints
72+
- **Rate Limiting**: Redis-backed rate limiting per API key tier
73+
- **Error Handling**: Centralized error handling with structured responses
74+
- **Request Logging**: Comprehensive logging with correlation IDs
7575

7676
:::
7777

78-
### ⚙️ Service Layer
78+
### Service Layer
7979

8080
Business logic and orchestration
8181

@@ -87,7 +87,7 @@ Business logic and orchestration
8787
| **CacheService** | Performance optimization | Redis caching, analytics |
8888
| **UserService** | User management | Authentication, profiles |
8989

90-
### 📊 Data Layer
90+
### Data Layer
9191

9292
Storage and external services
9393

@@ -118,7 +118,7 @@ AI Processing
118118

119119
## Design Patterns
120120

121-
### 🔄 1. Dependency Injection
121+
### 1. Dependency Injection
122122

123123
Constructor-based dependency injection for loose coupling
124124

@@ -134,9 +134,9 @@ export class SearchService {
134134

135135
::: tip Benefits
136136

137-
- **🧪 Improved Testability**: Easy mocking for unit tests
138-
- **🔄 Flexible Composition**: Services can be easily swapped
139-
- **🔗 Clear Dependencies**: Explicit dependency relationships
137+
- **Improved Testability**: Easy mocking for unit tests
138+
- **Flexible Composition**: Services can be easily swapped
139+
- **Clear Dependencies**: Explicit dependency relationships
140140

141141
:::
142142

docs/development/git-workflow.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Comprehensive commit verification system for Altus 4 to ensure code
77

88
This document outlines the comprehensive commit verification system implemented in Altus 4 to ensure code quality, security, and proper Git hygiene.
99

10-
## 🔐 **GPG Commit Signing**
10+
## GPG Commit Signing
1111

1212
### Setup GPG Signing
1313

@@ -98,7 +98,7 @@ Prevents pushing problematic commits:
9898
- **Interactive Prompts** for unsigned commits or security issues
9999
- **Protected Branch** detection (main/master)
100100

101-
## 🛠️ **Available Commands**
101+
## Available Commands
102102

103103
### Verification Commands
104104

@@ -133,7 +133,7 @@ npm run commit:configure-signing
133133
./bin/setup-gpg.sh configure
134134
```
135135

136-
## 📋 **Commit Message Format**
136+
## Commit Message Format
137137

138138
We use **Conventional Commits** for consistency:
139139

@@ -167,7 +167,7 @@ docs: update README with new authentication flow
167167
test: add unit tests for ApiKeyService
168168
```
169169

170-
## 🔍 **Verification Process**
170+
## Verification Process
171171

172172
### Before Each Commit
173173

@@ -234,7 +234,7 @@ If hooks are too slow:
234234
2. **Optimize Tests**: Use `--bail` for faster failure
235235
3. **Cache Dependencies**: Ensure node_modules is cached
236236

237-
## 🎯 **Best Practices**
237+
## Best Practices
238238

239239
### For Developers
240240

@@ -252,15 +252,15 @@ If hooks are too slow:
252252
4. **Monitor hook performance** and optimize as needed
253253
5. **Update verification tools** regularly
254254

255-
## 🔒 **Security Features**
255+
## Security Features
256256

257257
- **GPG Commit Signing**: Cryptographic verification of commit authorship
258258
- **Security Auditing**: Automatic vulnerability detection
259259
- **Sensitive Data Detection**: Prevents secrets in commit messages
260260
- **Interactive Prompts**: User confirmation for security issues
261261
- **Branch Protection**: Warnings for direct commits to protected branches
262262

263-
## 📈 **Metrics and Reporting**
263+
## Metrics and Reporting
264264

265265
The verification system provides detailed reporting:
266266

docs/examples/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2369,18 +2369,18 @@ class AltusAnalyticsDashboard extends EventEmitter {
23692369
console.log(`Last Updated: ${snapshot.timestamp.toLocaleString()}\n`)
23702370

23712371
// System status
2372-
const statusIcon = summary.status === 'healthy' ? '' : ''
2372+
const statusIcon = summary.status === 'healthy' ? '[OK]' : '[ERROR]'
23732373
console.log(
2374-
`🖥️ System Status: ${statusIcon} ${summary.status.toUpperCase()}`
2374+
`System Status: ${statusIcon} ${summary.status.toUpperCase()}`
23752375
)
23762376

23772377
if (snapshot.system.uptime) {
23782378
console.log(
2379-
`⏱️ Uptime: ${(snapshot.system.uptime / 3600).toFixed(1)} hours`
2379+
`Uptime: ${(snapshot.system.uptime / 3600).toFixed(1)} hours`
23802380
)
23812381
}
23822382

2383-
console.log('\n📊 SEARCH METRICS')
2383+
console.log('\nSEARCH METRICS')
23842384
console.log(''.repeat(50))
23852385
console.log(`Total Searches (30m): ${summary.totalSearches}`)
23862386
console.log(
@@ -2396,17 +2396,17 @@ class AltusAnalyticsDashboard extends EventEmitter {
23962396
console.log(`Total Users: ${snapshot.users.totalUsers || 0}`)
23972397

23982398
if (snapshot.users.topQueries && snapshot.users.topQueries.length > 0) {
2399-
console.log('\n🔍 TOP QUERIES')
2399+
console.log('\nTOP QUERIES')
24002400
snapshot.users.topQueries.slice(0, 5).forEach((query, i) => {
24012401
console.log(` ${i + 1}. "${query.text}" (${query.count})`)
24022402
})
24032403
}
24042404

24052405
if (snapshot.trends.length > 0) {
2406-
console.log('\n📈 TRENDING TOPICS')
2406+
console.log('\nTRENDING TOPICS')
24072407
console.log(''.repeat(50))
24082408
snapshot.trends.slice(0, 5).forEach(trend => {
2409-
const arrow = trend.growth > 0 ? '↗️' : trend.growth < 0 ? '↘️' : '➡️'
2409+
const arrow = trend.growth > 0 ? '' : trend.growth < 0 ? '' : ''
24102410
console.log(
24112411
` ${arrow} ${trend.category}: ${trend.queries} queries (+${trend.growth}%)`
24122412
)
@@ -2465,7 +2465,7 @@ async function startAnalyticsDashboard() {
24652465
// Set up event listeners
24662466
dashboard.on('metricsUpdated', snapshot => {
24672467
// Handle metrics updates
2468-
console.log(`📊 Metrics updated at ${snapshot.timestamp}`)
2468+
console.log(`Metrics updated at ${snapshot.timestamp}`)
24692469
})
24702470

24712471
dashboard.on('alerts', alerts => {
@@ -2488,7 +2488,7 @@ async function startAnalyticsDashboard() {
24882488
setInterval(async () => {
24892489
try {
24902490
const report = await dashboard.generateReport('1h')
2491-
console.log('📄 Hourly report generated')
2491+
console.log('Hourly report generated')
24922492

24932493
// Save report to file
24942494
const fs = require('fs')

docs/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ Visit `http://localhost:3000/health` to verify the installation.
6565

6666
## Key Features
6767

68-
- **🔍 Advanced Search**: Natural language, boolean, and semantic search modes
69-
- **🤖 AI Integration**: OpenAI-powered query optimization and result enhancement
70-
- **High Performance**: Intelligent caching and parallel database queries
71-
- **🔐 Enterprise Security**: API key authentication with tiered rate limiting
72-
- **📊 Rich Analytics**: Search trends, performance metrics, and insights
73-
- **🔧 Developer Friendly**: Comprehensive API documentation and examples
68+
- **Advanced Search**: Natural language, boolean, and semantic search modes
69+
- **AI Integration**: OpenAI-powered query optimization and result enhancement
70+
- **High Performance**: Intelligent caching and parallel database queries
71+
- **Enterprise Security**: API key authentication with tiered rate limiting
72+
- **Rich Analytics**: Search trends, performance metrics, and insights
73+
- **Developer Friendly**: Comprehensive API documentation and examples
7474

7575
## API Authentication
7676

@@ -90,10 +90,10 @@ Need help with Altus 4?
9090
- **Issues**: [GitHub Issues](https://github.com/yourusername/altus4/issues)
9191
- **Community**: [GitHub Discussions](https://github.com/yourusername/altus4/discussions)
9292

93-
## 🧪 Sync Test Status
93+
## Sync Test Status
9494

9595
**Last Updated**: December 2024
96-
**Test Status**: Documentation sync is working!
96+
**Test Status**: Documentation sync is working!
9797

9898
This section was added to test the automatic synchronization between the main repository (`altus4/website`) and the documentation repository (`altus4/docs`).
9999

@@ -104,7 +104,7 @@ This section was added to test the automatic synchronization between the main re
104104
3. **Target**: Automatically synced to `altus4/docs`
105105
4. **Deploy**: GitHub Pages automatically builds and deploys
106106

107-
If you can see this section in the `altus4/docs` repository, the sync is working perfectly! 🎉
107+
If you can see this section in the `altus4/docs` repository, the sync is working perfectly!
108108

109109
---
110110

0 commit comments

Comments
 (0)