Files
PineCreek_Web_2.0/.github/copilot-instructions.md
2026-06-14 19:56:38 -04:00

2.9 KiB

Pine Creek website — quick orientation for AI coding agents

This is a small static-ish website whose source lives at the repository root. Keep suggestions focused, minimal, and specific to the existing patterns.

  • Entry / what to edit

    • index.php is the site's entry point (contains the HTML structure, nav, hero, and sections). Edit content/structure here.
    • css/ contains SCSS source and compiled CSS. css/main.scss imports partials from css/components/ (e.g. _nav.scss, _slide.scss).
    • js/main.js is the single client-side script — it controls the hamburger/nav, slides, and a light client-side prompt-based auth.
  • Architecture & patterns (observable)

    • No framework/tooling files found (no package.json, build scripts). The project is organized as plain HTML/CSS/JS served from index.php.
    • SCSS pattern: variables at top of main.scss (colors, breakpoints), mixins for fonts (Libre, Lato), and partials under css/components/ imported by main.scss.
    • JS pattern: single-file imperative DOM manipulation (document.getElementById, querySelector, event handlers). Use const/let, short arrow functions and maintain global-scope structure similar to js/main.js.
    • Static assets: images in img/ follow numeric patterns (e.g. vineyard-0.jpg, house-0.jpg) used by slide logic in main.js.
  • Development / preview notes (inferred)

    • No CI or build discovered. To preview locally you can serve the folder with a simple server. A safe, minimal option: run php -S localhost:8000 from the project root and open http://localhost:8000/.
    • SCSS is present but not compiled by repo tooling. If modifying SCSS, compile to css/main.css using a local tool (example): sass css/main.scss css/main.css (assumption: developer will run this locally).
  • Conventions and gotchas to follow when changing code

    • Keep CSS partials modular. Add new component styles under css/components/ and import them in css/main.scss rather than editing compiled css/main.css directly.
    • JS uses simple DOM IDs/classes; prefer selecting elements by the same IDs/classes and follow the existing event-handler pattern (assign functions to onclick, small helpers like toggleNav, openNav, closeNav).
    • The project contains a client-side “light auth” in js/main.js that checks literal passwords ('12345', 'abcde'). Treat this as insecure; if asked to modify auth, recommend server-side changes and note security concerns.
  • When merging or editing .github/copilot-instructions.md

    • Preserve any human-authored guidance already present. If adding new items, keep them concise and cite files (e.g. index.php, css/main.scss, css/components/_nav.scss, js/main.js).

If anything above is unclear or you want more detail (build commands, preferred local dev workflow, or to add sample sass npm scripts), tell me which parts to expand or confirm and I will update this file.