Merge pull request #1 from ChipaDevTeam/copilot/create-professional-f… #3
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| docs: | |
| name: Build Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install sphinx sphinx-rtd-theme | |
| - name: Check README | |
| run: | | |
| # Verify README has minimum required sections | |
| grep -q "## Features" README.md || echo "Warning: README missing Features section" | |
| grep -q "## Installation" README.md || echo "Warning: README missing Installation section" | |
| grep -q "## Usage" README.md || echo "Warning: README missing Usage section" | |
| grep -q "## License" README.md || echo "Warning: README missing License section" | |
| - name: Validate Markdown | |
| run: | | |
| # Check for broken links (basic validation) | |
| echo "Checking markdown files..." | |
| find . -name "*.md" -type f | head -10 |