|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +## Project |
| 4 | + |
| 5 | +This repository contains Rudramani Singha's personal academic landing page for `singha.io`. |
| 6 | + |
| 7 | +The site is a Vite-powered static website. GitHub Pages deployment is Actions-only. Do not preserve or reintroduce GitHub Pages "Deploy from a branch" support. |
| 8 | + |
| 9 | +## Source of Truth |
| 10 | + |
| 11 | +- `index.html` is the main page and contains the current homepage content. |
| 12 | +- `stylesheet.css` is the current styling source. |
| 13 | +- `images/` contains the profile and project imagery. |
| 14 | +- `scripts/` contains research notebooks and artifacts linked from the site history. |
| 15 | +- `tools/` contains small build helpers. |
| 16 | +- `dist/` is generated output and should not be edited by hand or committed. |
| 17 | + |
| 18 | +## Content Rules |
| 19 | + |
| 20 | +- Do not rewrite biography, project descriptions, author lists, titles, metadata, or external links unless the user explicitly asks. |
| 21 | +- Keep the Art of Neuron project link pointed at `https://art-of-neuron.github.io/`. |
| 22 | +- Keep the custom domain as `singha.io`. |
| 23 | +- Do not add placeholder links such as `example.com`. |
| 24 | +- Preserve SEO/social metadata unless the requested change specifically concerns it. |
| 25 | + |
| 26 | +## Frontend Rules |
| 27 | + |
| 28 | +- Use Vite with npm and Node 24, as pinned by `.node-version`. |
| 29 | +- Keep dependencies minimal. The GitHub Actions path should stay well under 30 seconds whenever possible. |
| 30 | +- Do not add React, Svelte, Astro, Tailwind, or another framework without an explicit user decision. |
| 31 | +- Styling work should preserve the current content and improve presentation only. |
| 32 | +- Prefer small, plain static-site changes over architectural churn. |
| 33 | + |
| 34 | +## Commands |
| 35 | + |
| 36 | +Use these commands from the repository root: |
| 37 | + |
| 38 | +```bash |
| 39 | +npm install |
| 40 | +npm run dev |
| 41 | +npm run build |
| 42 | +npm run preview |
| 43 | +``` |
| 44 | + |
| 45 | +In CI, use: |
| 46 | + |
| 47 | +```bash |
| 48 | +npm ci |
| 49 | +npm run build |
| 50 | +``` |
| 51 | + |
| 52 | +## Deployment |
| 53 | + |
| 54 | +- GitHub Pages source must be set to GitHub Actions. |
| 55 | +- `.github/workflows/pages.yml` builds with Vite. |
| 56 | +- Pushes to `style` deploy the built `dist/` artifact. |
| 57 | +- Pull requests into `style` should build for validation only. |
| 58 | +- Ensure `CNAME`, `.nojekyll`, `404.html`, `favicon.ico`, and `stylesheet.css` are present in `dist/` after `npm run build`. |
| 59 | + |
| 60 | +## Development Workflow |
| 61 | + |
| 62 | +- Use the `style` branch as the main development and deployment branch. |
| 63 | +- Keep changes scoped and review the diff before finishing. |
| 64 | +- Run `npm run build` before reporting success. |
| 65 | +- If local Node is missing, use a temporary Node 24 runtime or state clearly that build verification could not be run. |
0 commit comments