Milestone 1: Documentation Foundation Structure
Created complete documentation structure with: • Root README.md with repository overview • Documentation directory structure (01-05 + templates) • Migrated content from public repository • New operational documentation • Comprehensive templates for business workflows Sections: 1. 01-business-strategy/ - Business vision, market analysis, financials 2. 02-technical-architecture/ - Infrastructure, AI agents, deployment 3. 03-operations/ - Client onboarding, support processes 4. 04-customer-portal/ - Placeholder for client-facing docs 5. 05-development/ - Placeholder for dev standards 6. templates/ - 5 reusable business templates This commit establishes the foundation for the repository reorganization. Content review will be conducted separately.
This commit is contained in:
@@ -0,0 +1,74 @@
|
||||
name: Documentation Validation
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
paths:
|
||||
- 'documentation/**'
|
||||
- 'README.md'
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
paths:
|
||||
- 'documentation/**'
|
||||
- 'README.md'
|
||||
|
||||
jobs:
|
||||
validate-docs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check for broken links
|
||||
run: |
|
||||
# Install link checker
|
||||
pip install linkchecker
|
||||
|
||||
# Check documentation links
|
||||
find documentation/ -name "*.md" -exec linkchecker --check-extern {} \;
|
||||
|
||||
- name: Validate markdown structure
|
||||
run: |
|
||||
# Check for required documentation sections
|
||||
echo "Validating documentation structure..."
|
||||
|
||||
# Check root README
|
||||
if [ ! -f "README.md" ]; then
|
||||
echo "❌ Missing root README.md"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check documentation directory exists
|
||||
if [ ! -d "documentation/" ]; then
|
||||
echo "❌ Missing documentation/ directory"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ Documentation structure validation passed"
|
||||
|
||||
- name: Run markdown lint
|
||||
uses: DavidAnson/markdownlint-cli2-action@v9
|
||||
with:
|
||||
globs: 'documentation/**/*.md README.md'
|
||||
|
||||
terraform-validation:
|
||||
runs-on: ubuntu-latest
|
||||
if: contains(github.event.head_commit.message, 'terraform') || contains(github.event.head_commit.message, 'infrastructure')
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Terraform
|
||||
uses: hashicorp/setup-terraform@v2
|
||||
with:
|
||||
terraform_version: 1.5.0
|
||||
|
||||
- name: Terraform Format
|
||||
id: fmt
|
||||
run: terraform fmt -check -recursive infrastructure/
|
||||
|
||||
- name: Terraform Init
|
||||
run: terraform init infrastructure/aws-org/
|
||||
|
||||
- name: Terraform Validate
|
||||
run: terraform validate infrastructure/aws-org/
|
||||
Reference in New Issue
Block a user