Skip to content

Commit 7211157

Browse files
committed
Remove outdated advanced documentation files and add troubleshooting guide for improved clarity and organization
1 parent 5a644c7 commit 7211157

File tree

8 files changed

+33
-94
lines changed

8 files changed

+33
-94
lines changed

docs/advanced/customization.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/advanced/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/advanced/navigation.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/advanced/search.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/index.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,6 @@ Follow these guides in order for a complete setup:
4949
- Including assets
5050
- Best practices
5151

52-
4. [Testing and Deployment](/documentation-automation/testing-deployment)
53-
- Local testing
54-
- Deployment verification
55-
- Troubleshooting common issues
56-
5752
## File Structure
5853

5954
```
@@ -63,12 +58,7 @@ docs/
6358
├── index.md
6459
├── repository-setup.md
6560
└── github-actions-setup.md
66-
├── writing-docs.md
67-
├── testing-deployment.md
68-
└── advanced/
69-
├── customization.md
70-
├── navigation.md
71-
└── search.md
61+
└── writing-docs.md
7262
```
7363

7464
## Requirements
@@ -82,6 +72,6 @@ docs/
8272

8373
1. Start with [Repository Setup](/documentation-automation/setup-guide/repository-setup) to create the basic structure
8474
2. Follow each guide in sequence
85-
3. Check [Troubleshooting](testing-deployment.md#troubleshooting) if you encounter issues
75+
3. Check [Troubleshooting](troubleshooting.md#common-issues) if you encounter issues
8676

87-
For advanced customization and features, check the [Advanced Topics](/documentation-automation/advanced/) section.
77+
For advanced customization and features, check the [just-the-docs documentation](https://just-the-docs.github.io/just-the-docs/)

docs/setup-guide/repository-setup.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,21 @@ First, you'll need to create the following folder structure in your repository:
1515

1616
```
1717
your-repository/
18+
├── .github/
19+
│ └── workflows/
20+
│ └── deploy-docs.yml
1821
├── docs/
1922
│ ├── _config.yml
2023
│ ├── Gemfile
2124
│ ├── index.md
2225
│ ├── setup-guide/
26+
│ │ ├── index.md
27+
│ │ ├── repository-setup.md
28+
│ │ └── github-actions-setup.md
2329
│ ├── writing-docs.md
24-
│ ├── testing-deployment.md
25-
│ └── advanced/
26-
├── .github/
27-
│ └── workflows/
28-
│ └── deploy-docs.yml
29-
└── .gitignore
30+
│ └── testing-deployment.md
31+
├── .gitignore
32+
└── README.md
3033
```
3134

3235
## Step-by-Step Setup

docs/testing-deployment.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/troubleshooting.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
title: Troubleshooting
4+
nav_order: 4
5+
---
6+
7+
# Troubleshooting
8+
<!-- troubleshooting.md -->
9+
10+
## Common Issues
11+
12+
1. **Check Build Status**
13+
- Monitor GitHub Actions
14+
- Review build logs
15+
16+
2. **Verify Deployment**
17+
- Check GitHub Pages URL
18+
- Validate content updates
19+
- Test navigation
20+
21+
[← Writing Documentation](writing-docs.md)

0 commit comments

Comments
 (0)