ADR-0001: Repository README and GitHub Pages Structure
Status
Accepted
Context
Weather-JEPA requires three distinct documentation surfaces:
- a repository landing page for developers, reviewers, and contributors;
- a public project website for scientific and educational communication;
- an authoritative research and engineering plan.
Using one document for all three purposes would make the repository introduction unwieldy and would weaken the distinction between public communication and governing requirements.
Decision
Weather-JEPA will use:
/README.mdas the GitHub repository landing page;/docs/index.mdas the GitHub Pages homepage;/docs/project-management/north-star-plan.mdas the authoritative governing plan.
GitHub Pages will initially publish from the main branch and /docs directory.
Consequences
The repository README and Pages homepage may summarize the same mission, research question, architecture, and project status. Detailed requirements remain centralized in the North-Star Plan.
Changes to research, architecture, data, evaluation, or engineering requirements must be made in the governing plan and recorded through an appropriate decision record.
Review Conditions
This decision should be reconsidered if the project migrates to MkDocs, Sphinx, Quarto, or another generated documentation framework.