docs: add development setup instructions #45
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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| documentation-structure: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check documentation structure | |
| run: | | |
| # Verify required documentation files exist | |
| test -f docs/quickstart.md || { echo "Error: docs/quickstart.md missing"; exit 1; } | |
| test -f docs/architecture.md || { echo "Error: docs/architecture.md missing"; exit 1; } | |
| test -f docs/tutorial.md || { echo "Error: docs/tutorial.md missing"; exit 1; } | |
| test -f docs/api-reference.md || { echo "Error: docs/api-reference.md missing"; exit 1; } | |
| echo "All required documentation files present" |