How offa/android-foss works
Project type and purpose
• Type: A static website / documentation site (curated list of Free & Open Source Android apps)
• Purpose: Authors maintain a Markdown list (README.md) plus tutorials; CI checks, sorting scripts keep content tidy; output is a single index.html deployed to GitHub Pages.
Main components
a. Content layer
– README.md (the master list)
– tutorials/Install-Rooted-OTA.md
– supporting files (CONTRIBUTING.md, LICENSE, .markdownlint.json)
b. Scripts & tooling
– check.sh & check_manually.sh (shell scripts for content validation)
– ensure_sorted.py (Python script to enforce alphabetical order)
c. CI/CD pipelines (.github/workflows)
– ci.yml (runs lint, sorting checks, link tests)
– codeql.yml (security scanning)
d. Build output
– index.html (generated or hand-edited static site entry point)
e. Hosting & delivery
– GitHub Pages (serves index.html)
– End user web browser (visitors)
Relationships and data flow
1. Developer pushes commits to GitHub repo
2. GitHub Actions triggers:
• ci.yml → runs markdown lint → runs ensure_sorted.py → runs link checks
• codeql.yml → performs code-scanning
3. On success, build step (if any) generates/updates index.html
4. Deploy to GitHub Pages branch or gh-pages →
5. End users fetch index.html via browser
6. Optional: tutorials are also exposed via links from index.html
Architectural patterns & principles
– Static-site generation: no dynamic server components
– CI-driven validation: automated content quality and security checks
– Single-source content: Markdown as source of truth, HTML as artifact
– Separation of concerns: content vs tooling vs hosting
Technology & frameworks
– Markdown (content format)
– Python (ensure_sorted.py)
– Bash (check.sh)
– GitHub Actions (CI/CD)
– GitHub Pages (hosting)
– markdownlint (style enforcement via .markdownlint.json)