Skip to content

Commit 3d035c6

Browse files
committed
fix: resolve formatting conflicts between Prettier and markdownlint
- Updated .markdownlint.json to use asterisk style for MD049/MD050 rules - This aligns with Prettier's formatting of bold text (**text**) - All formatting and linting checks now pass successfully - Resolves CI formatting failures in GitHub Actions
1 parent 720c711 commit 3d035c6

46 files changed

Lines changed: 7402 additions & 6931 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.markdownlint.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141
},
4242
"MD047": false,
4343
"MD049": {
44-
"style": "underscore"
44+
"style": "asterisk"
4545
},
4646
"MD050": {
47-
"style": "underscore"
47+
"style": "asterisk"
4848
},
4949
"MD051": false
5050
}

DOCS_SYNC_SETUP.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ This guide will help you set up automatic synchronization between your main repo
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 with Mermaid diagram support
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 with Mermaid diagram support
12+
- **Manual sync**: Script for manual synchronization when needed
1313

1414
## Prerequisites
1515

16-
1. __GitHub Account__ with permissions to create repositories in the `altus4` organization
17-
2. __Git configured__ with SSH keys or personal access token
18-
3. __Repository access__ to both main and docs repositories
16+
1. **GitHub Account** with permissions to create repositories in the `altus4` organization
17+
2. **Git configured** with SSH keys or personal access token
18+
3. **Repository access** to both main and docs repositories
1919

2020
## Step-by-Step Setup
2121

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

24-
1. __Create the repository__ on GitHub:
24+
1. **Create the repository** on GitHub:
2525

2626
```text
2727
Repository name: altus4/docs
@@ -30,48 +30,48 @@ The setup creates:
3030
Initialize: Add a README file
3131
```
3232

33-
2. __Enable GitHub Pages__:
34-
- Go to repository __Settings____Pages__
35-
- Source: __GitHub Actions__
33+
2. **Enable GitHub Pages**:
34+
- Go to repository **Settings****Pages**
35+
- Source: **GitHub Actions**
3636
- This allows the workflow to deploy automatically
3737

3838
### Step 2: Create Personal Access Token
3939

40-
1. __Generate a token__:
41-
- Go to GitHub __Settings____Developer settings____Personal access tokens____Tokens (classic)__
42-
- Click __Generate new token (classic)__
40+
1. **Generate a token**:
41+
- Go to GitHub **Settings****Developer settings****Personal access tokens****Tokens (classic)**
42+
- Click **Generate new token (classic)**
4343
- Name: `docs-sync-token`
44-
- Expiration: __No expiration__ (or set as needed)
44+
- Expiration: **No expiration** (or set as needed)
4545
- Scopes:
4646
- `repo` (Full control of private repositories)
4747
- `workflow` (Update GitHub Action workflows)
4848

49-
2. __Copy the token__ - you'll need it in the next step
49+
2. **Copy the token** - you'll need it in the next step
5050

5151
### Step 3: Configure Repository Secrets
5252

53-
In your __main repository__ (this one):
53+
In your **main repository** (this one):
5454

55-
1. Go to __Settings____Secrets and variables____Actions__
56-
2. Click __New repository secret__
55+
1. Go to **Settings****Secrets and variables****Actions**
56+
2. Click **New repository secret**
5757
3. Add the following secret:
58-
- __Name__: `DOCS_SYNC_TOKEN`
59-
- __Value__: The personal access token from Step 2
58+
- **Name**: `DOCS_SYNC_TOKEN`
59+
- **Value**: The personal access token from Step 2
6060

6161
### Step 4: Test the Setup
6262

63-
1. __Make a change__ to any file in the `docs/` directory
64-
2. __Commit and push__ to the `main` or `develop` branch:
63+
1. **Make a change** to any file in the `docs/` directory
64+
2. **Commit and push** to the `main` or `develop` branch:
6565

6666
```bash
6767
git add docs/
6868
git commit -m "docs: test sync setup"
6969
git push origin main
7070
```
7171

72-
3. __Check the Actions tab__ in your main repository to see the sync workflow running
73-
4. __Verify the docs repository__ receives the changes
74-
5. __Check GitHub Pages__ deployment (may take a few minutes)
72+
3. **Check the Actions tab** in your main repository to see the sync workflow running
73+
4. **Verify the docs repository** receives the changes
74+
5. **Check GitHub Pages** deployment (may take a few minutes)
7575

7676
## Manual Sync Options
7777

@@ -97,9 +97,9 @@ npm run docs:sync:force
9797

9898
### Using GitHub Actions (Manual Trigger)
9999

100-
1. Go to __Actions__ tab in your main repository
101-
2. Select __Sync Documentation__ workflow
102-
3. Click __Run workflow__
100+
1. Go to **Actions** tab in your main repository
101+
2. Select **Sync Documentation** workflow
102+
3. Click **Run workflow**
103103
4. Choose branch and optionally force sync
104104

105105
## Repository Structure
@@ -168,17 +168,17 @@ on:
168168
169169
### Common Issues
170170
171-
1. __Permission Denied__
171+
1. **Permission Denied**
172172
- Check that `DOCS_SYNC_TOKEN` secret is set correctly
173173
- Verify token has `repo` and `workflow` permissions
174174
- Ensure token hasn't expired
175175

176-
2. __Repository Not Found__
176+
2. **Repository Not Found**
177177
- Verify `altus4/docs` repository exists
178178
- Check repository name in script matches exactly
179179
- Ensure you have access to the docs repository
180180

181-
3. __Sync Script Fails__
181+
3. **Sync Script Fails**
182182
- Run script manually to see detailed error messages:
183183

184184
```bash
@@ -187,7 +187,7 @@ on:
187187

188188
- Check git configuration and credentials
189189

190-
4. __GitHub Pages Not Deploying__
190+
4. **GitHub Pages Not Deploying**
191191
- Verify GitHub Pages is enabled in docs repository settings
192192
- Check that Pages source is set to "GitHub Actions"
193193
- Review the deploy workflow in the docs repository
@@ -211,27 +211,27 @@ bash -x scripts/sync-docs.sh
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

219219
## Next Steps
220220

221221
After setup is complete:
222222

223-
1. __Bookmark the docs site__: `https://altus4.github.io/docs`
224-
2. __Update README__: Add link to documentation site
225-
3. __Team notification__: Inform team about the new documentation workflow
226-
4. __Monitor__: Check sync status after first few documentation changes
223+
1. **Bookmark the docs site**: `https://altus4.github.io/docs`
224+
2. **Update README**: Add link to documentation site
225+
3. **Team notification**: Inform team about the new documentation workflow
226+
4. **Monitor**: Check sync status after first few documentation changes
227227

228228
## Useful Links
229229

230-
- __Documentation Site__: <https://altus4.github.io/docs>
231-
- __Docs Repository__: <https://github.com/altus4/docs>
232-
- __VitePress Documentation__: <https://vitepress.dev/>
233-
- __GitHub Actions Documentation__: <https://docs.github.com/en/actions>
230+
- **Documentation Site**: <https://altus4.github.io/docs>
231+
- **Docs Repository**: <https://github.com/altus4/docs>
232+
- **VitePress Documentation**: <https://vitepress.dev/>
233+
- **GitHub Actions Documentation**: <https://docs.github.com/en/actions>
234234

235235
---
236236

237-
__Need help?__ Check the troubleshooting section above or create an issue in the main repository.
237+
**Need help?** Check the troubleshooting section above or create an issue in the main repository.

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@ A modern, responsive marketing website for Altus 4 - an AI-enhanced MySQL full-t
44

55
## Features
66

7-
- __Modern Design__: Clean, professional design with gradient backgrounds and smooth animations
8-
- __Responsive__: Mobile-first design that works on all devices
9-
- __Performance Optimized__: Fast loading with optimized assets and smooth scrolling
10-
- __SEO Friendly__: Comprehensive meta tags and semantic HTML structure
11-
- __Accessible__: Built with accessibility best practices
12-
- __Documentation__: Integrated VitePress documentation with automatic sync to separate repository
7+
- **Modern Design**: Clean, professional design with gradient backgrounds and smooth animations
8+
- **Responsive**: Mobile-first design that works on all devices
9+
- **Performance Optimized**: Fast loading with optimized assets and smooth scrolling
10+
- **SEO Friendly**: Comprehensive meta tags and semantic HTML structure
11+
- **Accessible**: Built with accessibility best practices
12+
- **Documentation**: Integrated VitePress documentation with automatic sync to separate repository
1313

1414
## Tech Stack
1515

16-
- __Framework__: Vue.js 3 (Composition API)
17-
- __Language__: TypeScript
18-
- __Styling__: Tailwind CSS
19-
- __Components__: Custom UI components inspired by Shadcn-Vue
20-
- __Icons__: Lucide Vue Next
21-
- __Build Tool__: Vite
22-
- __Documentation__: VitePress
16+
- **Framework**: Vue.js 3 (Composition API)
17+
- **Language**: TypeScript
18+
- **Styling**: Tailwind CSS
19+
- **Components**: Custom UI components inspired by Shadcn-Vue
20+
- **Icons**: Lucide Vue Next
21+
- **Build Tool**: Vite
22+
- **Documentation**: VitePress
2323

2424
## Sections
2525

26-
1. __Hero Section__: Value proposition with clear CTA buttons
27-
1. __Features Section__: Showcase of key capabilities (AI, Performance, Security)
28-
1. __Technical Specifications__: Architecture overview and tech stack details
29-
1. __Project Status__: Current metrics, completion status, and roadmap
30-
1. __Call to Action__: Community engagement and quick start links
31-
1. __Footer__: Contact information, resources, and tech stack
26+
1. **Hero Section**: Value proposition with clear CTA buttons
27+
1. **Features Section**: Showcase of key capabilities (AI, Performance, Security)
28+
1. **Technical Specifications**: Architecture overview and tech stack details
29+
1. **Project Status**: Current metrics, completion status, and roadmap
30+
1. **Call to Action**: Community engagement and quick start links
31+
1. **Footer**: Contact information, resources, and tech stack
3232

3333
## Quick Start
3434

@@ -80,8 +80,8 @@ npm run preview
8080

8181
The website uses a custom color palette defined in `tailwind.config.js`. Main colors:
8282

83-
- __Primary__: Blue (#3b82f6) for buttons and accents
84-
- __Secondary__: Gray scale for text and backgrounds
83+
- **Primary**: Blue (#3b82f6) for buttons and accents
84+
- **Secondary**: Gray scale for text and backgrounds
8585

8686
### Components
8787

@@ -95,12 +95,12 @@ All UI components are located in `src/components/ui/` and can be easily customiz
9595

9696
To update the content:
9797

98-
1. __Hero Section__: Edit `src/components/HeroSection.vue`
99-
2. __Features__: Modify `src/components/FeaturesSection.vue`
100-
3. __Tech Specs__: Update `src/components/TechSpecsSection.vue`
101-
4. __Project Status__: Change metrics in `src/components/ProjectStatusSection.vue`
102-
5. __CTA__: Customize links in `src/components/CallToActionSection.vue`
103-
6. __Footer__: Update contact info in `src/components/FooterSection.vue`
98+
1. **Hero Section**: Edit `src/components/HeroSection.vue`
99+
2. **Features**: Modify `src/components/FeaturesSection.vue`
100+
3. **Tech Specs**: Update `src/components/TechSpecsSection.vue`
101+
4. **Project Status**: Change metrics in `src/components/ProjectStatusSection.vue`
102+
5. **CTA**: Customize links in `src/components/CallToActionSection.vue`
103+
6. **Footer**: Update contact info in `src/components/FooterSection.vue`
104104

105105
## Documentation
106106

@@ -114,9 +114,9 @@ Live Documentation: [https://altus4.github.io/docs](https://altus4.github.io/doc
114114

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

117-
- __Automatic__: Triggered on push to `main` or `develop` branches
118-
- __Manual__: Use `npm run docs:sync` for manual synchronization
119-
- __GitHub Pages__: Auto-deployment to documentation site
117+
- **Automatic**: Triggered on push to `main` or `develop` branches
118+
- **Manual**: Use `npm run docs:sync` for manual synchronization
119+
- **GitHub Pages**: Auto-deployment to documentation site
120120

121121
### Working with Documentation
122122

@@ -166,9 +166,9 @@ Tailwind is configured in `tailwind.config.js` with:
166166

167167
## Performance
168168

169-
- __Lighthouse Score__: 90+ (Performance, Accessibility, Best Practices, SEO)
170-
- __Bundle Size__: Optimized with Vite's tree shaking
171-
- __Loading Speed__: Lazy loading and optimized images
169+
- **Lighthouse Score**: 90+ (Performance, Accessibility, Best Practices, SEO)
170+
- **Bundle Size**: Optimized with Vite's tree shaking
171+
- **Loading Speed**: Lazy loading and optimized images
172172

173173
## Deployment
174174

@@ -196,7 +196,7 @@ This project is licensed under the MIT License.
196196

197197
## Author
198198

199-
Thavarshan
199+
Jerome (Thavarshan) Thayananthajothy
200200

201201
- Website: [thavarshan.com](https://thavarshan.com)
202202
- GitHub: [@thavarshan](https://github.com/thavarshan)
@@ -207,4 +207,4 @@ Contributions, issues, and feature requests are welcome! Feel free to check the
207207

208208
---
209209

210-
Made with care for the Altus 4 project
210+
Made with ❤️ for the Altus 4 project by Jerome Thayananthajothy

0 commit comments

Comments
 (0)