|
1 | | -<!-- Copilot / AI coding agent instructions for AmmarAhmedl200961.github.io --> |
2 | | -# Quick Agent Guide — AmmarAhmedl200961.github.io |
3 | | - |
4 | | -This repository is a simple personal GitHub Pages site. The guidance below is focused, actionable, and specific to this codebase so an AI coding agent can be immediately productive. |
5 | | - |
6 | | -1) Big picture |
7 | | -- Purpose: a static personal site (portfolio/resume) hosted on GitHub Pages. |
8 | | -- Entry point: `index.html` is the canonical site source (full HTML document). Styling is in `styles.css`. |
9 | | -- Jekyll hint: `_config.yml` references a `remote_theme: pages-themes/cayman@v0.2.0`. However, the repo contains a full `index.html` which takes precedence for the site's content. |
10 | | - |
11 | | -2) Key files and what to change |
12 | | -- `index.html`: edit content, sections, links, and project entries. Projects live in the `<section id="projects">` list — add `<li>` items there. |
13 | | -- `styles.css`: site styling and color palette. Keep class names and structure consistent with the HTML. |
14 | | -- `_config.yml`: contains the remote theme setting. Avoid changing unless you understand GitHub Pages/Jekyll implications. |
15 | | -- `README.md`: repo description. |
16 | | -- Static assets (images): referenced from the repository root (e.g., `IMG-20191018-WA0004.jpg`). Add images to repo root or update paths accordingly. |
17 | | - |
18 | | -3) Developer workflows (how to preview and validate changes) |
19 | | -- Fast static preview (no Jekyll required): run from repo root: |
20 | | - - `python3 -m http.server 8000` then open `http://localhost:8000`. |
21 | | -- Jekyll preview (optional): `_config.yml` indicates use of a remote theme. There is no `Gemfile` in this repo, so the Jekyll workflow is optional — if you need theme rendering locally, add a `Gemfile` and install bundler, then: |
22 | | - - `bundle install` |
23 | | - - `bundle exec jekyll serve --livereload` |
24 | | - Note: GitHub Pages will build the site on push; local Jekyll preview requires adding the appropriate dependencies. |
25 | | - |
26 | | -4) Conventions & patterns to follow |
27 | | -- Keep `index.html` as the single-page source; the repo uses direct HTML rather than templates/partials. |
28 | | -- Use CDN links already present (Bootstrap, shields) unless replacing with local assets — updating CDNs changes load characteristics and should be tested. |
29 | | -- Images are referenced with relative paths from the repo root. Verify file names and case-sensitivity (Linux filesystem). |
30 | | - |
31 | | -5) Integration points, external dependencies, and links |
32 | | -- External CDNs: Bootstrap CSS and shields (badges) are loaded from external URLs in `index.html`. |
33 | | -- External projects: project links point to other GitHub repos — do not rewrite those unless intentionally redirecting. |
34 | | - |
35 | | -6) Safe, repository-specific edit examples |
36 | | -- Add a project entry (inside `<section id="projects">`): |
37 | | - |
38 | | -```html |
39 | | -<li> |
40 | | - <strong><a href="https://github.com/OWNER/REPO">Project Title</a></strong> |
41 | | - <p>One-line description. Keep formatting consistent with existing items.</p> |
42 | | -</li> |
| 1 | +<!-- Copilot / AI coding agent instructions for AmmarAhm3d.github.io --> |
| 2 | +# Quick Agent Guide — AmmarAhm3d.github.io |
| 3 | + |
| 4 | +Personal portfolio site for Ammar Ahmed - Agentic AI Consultant. |
| 5 | + |
| 6 | +## Tech Stack |
| 7 | +- **Astro** - Fast static site generator |
| 8 | +- **React** - Interactive components |
| 9 | +- **Tailwind CSS** - Styling |
| 10 | +- **Framer Motion** - Animations |
| 11 | +- **Three.js** - 3D graphics |
| 12 | + |
| 13 | +## Project Structure |
| 14 | +- `src/pages/` - Astro pages |
| 15 | +- `src/components/` - React components (Hero, CaseStudies, Skills, Timeline, Projects, Booking, Footer, WhatsAppButton) |
| 16 | +- `src/layouts/` - Layout templates |
| 17 | +- `src/utils/` - Utility functions (GitHub API) |
| 18 | +- `public/` - Static assets |
| 19 | + |
| 20 | +## Key Features |
| 21 | +- Hero section with tagline "I build Agentic AI systems that replace entire teams" |
| 22 | +- Case studies with realistic metrics |
| 23 | +- Tech stack and skills display |
| 24 | +- Education and experience timeline |
| 25 | +- GitHub projects integration |
| 26 | +- Calendly embed for booking consultations |
| 27 | +- WhatsApp floating button |
| 28 | + |
| 29 | +## Development |
| 30 | +```bash |
| 31 | +npm install |
| 32 | +npm run dev |
43 | 33 | ``` |
44 | 34 |
|
45 | | -- Add an image: put the image file at repo root (e.g., `assets/my-photo.jpg` or root), then reference `src="assets/my-photo.jpg"` and commit both the HTML and image together. |
46 | | - |
47 | | -7) What to avoid or watch for |
48 | | -- Don't remove or alter `_config.yml` remote_theme without validating local builds — it can change theme behavior on GitHub Pages. |
49 | | -- Watch image filenames and paths (case-sensitive). If images show 404 in browser, confirm file is committed and path matches exactly. |
50 | | - |
51 | | -8) No tests / CI |
52 | | -- This repository contains no test suite or CI. Validate changes with a local static server and browser checks (console errors, 404s). |
| 35 | +## Build |
| 36 | +```bash |
| 37 | +npm run build |
| 38 | +``` |
53 | 39 |
|
54 | | -9) Commit and PR guidance for agents |
55 | | -- Make small, atomic commits (one logical change per PR). Title PRs clearly (e.g., "Add new project: Film Recommendation System"). |
56 | | -- For content changes, include a screenshot or link to a deployed preview in the PR description when possible. |
| 40 | +Static output to `dist/` directory for GitHub Pages. |
57 | 41 |
|
58 | | -If anything here is unclear or you'd like more examples (e.g., sample PR body, suggested `Gemfile` for Jekyll preview), tell me which part to expand and I will iterate. |
| 42 | +## Links |
| 43 | +- Calendly: calendly.com/ammarahm3d |
| 44 | +- WhatsApp: +923365442539 |
| 45 | +- GitHub: github.com/AmmarAhm3d |
0 commit comments