How ds-ai-gate/dsai-gate works
Purpose and Entry Points
DSAI-GATE is a curated, syllabus-aligned learning repository for the GATE Data Science and AI exam. Its primary human entry point is README.md, which links topic guides and practice assets. Its deployable entry point is the syllabus-explorer application in webapp/app.py, built into a static GitHub Pages site.
Curriculum Content Layer
Topic-level Markdown files organize external links, notes, courses, and practice material by syllabus domain:
• Probability-Statistics-Readme.md
• Machine-Learning-Readme.md
• Artificial-Intelligence-Readme.md
These documents are the authoritative navigational content for the repository’s subject structure. Resources.md and Topic_Resources/ supplement them with cross-topic materials and standalone conceptual notes.
Local Learning Assets
The repository stores study artifacts directly rather than serving data from a database or remote content API. Major asset groups are:
• Data/ — topic folders, PDFs, cheat sheets, and indexes.
• PYQ/ — official previous-year papers, answer keys, and PYQ/SHA256SUMS integrity metadata.
• notebooks/ — executable/printable instructional notebooks across ML, probability, algebra, and algorithms.
Notebook content is both educational material and a reproducible-code boundary; examples include notebooks/machine_learning/kmeans_from_scratch.ipynb and notebooks/probability/conditional_probability_and_bayes.ipynb.
Static Explorer Application
webapp/ is a Python-backed static-site generator, not a persistent web service:
• webapp/app.py is the application/export entry point.
• webapp/content.py derives explorer content from repository materials.
• webapp/build.py assembles the static export.
• webapp/templates/index.html, webapp/static/app.js, and webapp/static/styles.css define browser presentation and interactivity.
The flow is repository content → Python content/build stages → generated HTML/CSS/JS artifact → GitHub Pages. Dependencies are isolated in webapp/requirements.txt; no database, authentication layer, or server-side external service is indicated.
Content Generation and Validation
Supporting scripts provide repository-maintenance boundaries:
• scripts/build_example_notebooks.py builds example notebooks.
• scripts/check_new_links.py checks newly introduced links.
• fix_links.py supports link remediation.
The webapp has a direct test surface in webapp/tests.py; repository link-check behavior is covered by scripts/test_check_new_links.py. These controls protect a content-heavy repository where broken external references are a material quality risk.
Delivery Infrastructure
GitHub Actions is the runtime infrastructure:
• .github/workflows/pages.yml builds/tests relevant changes and publishes the static explorer to GitHub Pages on main.
• .github/workflows/repository-checks.yml provides repository validation.
The deployed external endpoint is GitHub Pages (ds-ai-gate.github.io/dsai-gate/). External dependencies are primarily linked educational resources, official GATE syllabus/paper sources, GitHub Actions, and GitHub Pages.
Maintenance Direction
Maintainer plans and operating constraints are documented separately from end-user curriculum:
• docs/implementation_plan.md
• docs/webapp.md
• docs/agent.md
This separates evolving product/deployment decisions from durable study content, while pull-request-based collaboration governs changes.
Main entry points: content.py Content derivation · pages.yml Pages workflow · build.py Static export builder · README.md Repository entry
Components 17
Curriculum
- Repository entry · Primary human navigation entry point.
README.md - Syllabus topic guides · Authoritative subject navigation across probability, ML, and AI.
- Supplementary resources
Resources.md
Learning Assets
- Study data library
- Previous-year papers · Includes SHA-256 integrity metadata.
- Instructional notebooks · Reproducible learning examples across syllabus areas.
Static Explorer
- Explorer application
webapp/app.py - Content derivation · Builds explorer content from repository materials.
webapp/content.py - Static export builder
webapp/build.py - Explorer browser UI
webapp/templates/index.html
Build & Delivery
- Example notebook builder
scripts/build_example_notebooks.py - Link validation · Checks new links and supports remediation.
scripts/check_new_links.py - Explorer tests
webapp/tests.py - Pages workflow · Tests, builds, and publishes changes from main.
.github/workflows/pages.yml - Repository checks
.github/workflows/repository-checks.yml
Other components
- GitHub Pages · Public deployment endpoint.
- Maintainer guidance · Separates operating decisions from learner curriculum.
docs/implementation_plan.md
Connections 20
- Repository entry → Syllabus topic guides: links to
- Repository entry → Supplementary resources: links to
- Syllabus topic guides → Study data library: organizes
- Syllabus topic guides → Previous-year papers: points learners to
- Syllabus topic guides → Instructional notebooks: points learners to
- Supplementary resources → Study data library: supplements
- Study data library → Content derivation: source material
- Previous-year papers → Content derivation: source material
- Instructional notebooks → Content derivation: source material
- Syllabus topic guides → Content derivation: curriculum structure
- Example notebook builder → Instructional notebooks: generates examples
- Explorer application → Content derivation: uses
- Content derivation → Static export builder: provides explorer content
- Static export builder → Explorer browser UI: renders static site
- Link validation → Syllabus topic guides: checks external links
- Repository checks → Link validation: runs validation
- Pages workflow → Explorer tests: runs
- Pages workflow → Static export builder: builds
- Pages workflow → GitHub Pages: publishes
- Maintainer guidance → Pages workflow: documents deployment