@@ -6,22 +6,22 @@ This guide will help you set up automatic synchronization between your main repo
66
77The 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 **
57573 . 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 **
1031034 . 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
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
212212When 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
221221After 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.
0 commit comments