Skip to content

Commit 9fcdf66

Browse files
committed
Remove outdated setup documentation and reorganize navigation structure
1 parent b9481f5 commit 9fcdf66

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Home
33
layout: home
4+
nav_order: 1
45
---
56

67
# Getting Started with Documentation Automation
File renamed without changes.

docs/setup/index.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Setup Guide
3+
layout: default
4+
nav_order: 2
5+
has_children: true
6+
---
7+
8+
# Documentation Setup Guide
9+
10+
This section walks you through the complete setup process for automated documentation deployment. Follow these guides in sequence to establish your documentation system.
11+
12+
## Setup Process Overview
13+
14+
The setup process is divided into three main stages:
15+
16+
### 1. [Repository Setup](repo-setup.md)
17+
Set up your GitHub repository with the correct structure and configurations.
18+
19+
**Key steps:**
20+
- Create repository folder structure
21+
- Configure required files
22+
- Set up GitHub repository settings
23+
- Enable GitHub Pages
24+
25+
**Time estimate:** 15-20 minutes
26+
27+
### 2. [GitHub Actions Setup](action-setup.md)
28+
Configure automated deployment using GitHub Actions.
29+
30+
**Key steps:**
31+
- Set up workflow file
32+
- Configure deployment triggers
33+
- Set required permissions
34+
- Configure deployment environment
35+
36+
**Time estimate:** 10-15 minutes
37+
38+
### 3. [Jekyll Setup](jekyll-setup.md)
39+
Configure Jekyll for documentation generation.
40+
41+
**Key steps:**
42+
- Install required dependencies
43+
- Configure Jekyll theme
44+
- Set up site configuration
45+
- Configure search and navigation
46+
47+
**Time estimate:** 15-20 minutes
48+
49+
## Prerequisites
50+
51+
Before starting the setup process, ensure you have:
52+
53+
- A GitHub account with repository creation permissions
54+
- Git installed on your local machine
55+
- A text editor for editing configuration files
56+
- Ruby installed (for local testing)
57+
58+
## Setup Checklist
59+
60+
Use this checklist to track your progress:
61+
62+
- [ ] Create repository structure
63+
- [ ] Configure GitHub repository settings
64+
- [ ] Set up GitHub Actions workflow
65+
- [ ] Configure Jekyll
66+
- [ ] Test local build
67+
- [ ] Verify deployment
68+
69+
## Getting Help
70+
71+
If you encounter issues during setup:
72+
73+
1. Check the troubleshooting section in each guide
74+
2. Review the [Testing and Deployment](../testing-deployment.md) guide
75+
3. Create an issue in the GitHub repository
76+
77+
## Next Steps
78+
79+
After completing the setup:
80+
81+
1. Review the [Writing Documentation](../writing-docs.md) guide
82+
2. Add your documentation content
83+
3. Test the automated deployment
84+
85+
[← Back to Home](../index.md)
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)