commit 65339df6d53883bfc2b8cd4542a7a5bf523c6bd8 · andreijiroh.dev/site

+97
.github/copilot-instructions.md
···

       1
       1
       +
       # GitHub Copilot / AI agent instructions

     

       2
       2
       +
       

     

       3
       3
       +
       Purpose: help an AI coding agent be immediately productive in this repository.

     

       4
       4
       +
       

     

       5
       5
       +
       - Big picture

     

       6
       6
       +
         - Static site built with MkDocs + Material theme. Sources live in `markdown/`; generated site is written to `public/` ([mkdocs.yml](mkdocs.yml)).

     

       7
       7
       +
         - Theme customizations and build hooks are in `overrides/` (Python hooks + theme assets).

     

       8
       8
       +
         - A parallel Gemini site lives in `gmi/` (different format, separate publishing flow).

     

       9
       9
       +
         - Cloudflare Pages / Workers integration: see `wrangler.jsonc` (publishes assets from `public/`).

     

       10
       10
       +
       

     

       11
       11
       +
       - Key workflows (concrete commands)

     

       12
       12
       +
         - Install dependencies (preferred): `pipenv install` (or `pip install -r requirements.txt`). See [Pipfile](Pipfile) and [requirements.txt](requirements.txt).

     

       13
       13
       +
         - Local preview: `mkdocs serve --watch overrides --watch-theme --livereload` or `pipenv run dev` (see `Pipfile` scripts and [mkdocs.yml](mkdocs.yml)).

     

       14
       14
       +
         - Build site: `pipenv run build` or `pipenv run build -f mkdocs.readthedocs.yml` (build targets in `Pipfile` and `build.sh`). `build.sh` copies favicon into `public/` after build.

     

       15
       15
       +
         - Cloudflare deploy (manual): `npm run deploy` -> `wrangler deploy` (see `package.json` and [wrangler.jsonc](wrangler.jsonc)). CI deploy logic uses `npx wrangler pages publish` in `bin/deploy.sh` when running under CI.

     

       16
       16
       +
         - CI: deployments happen via GitLab CI; do not rely on a repository-local Docker CI image.

     

       17
       17
       +
       

     

       18
       18
       +
       - Project-specific conventions & patterns

     

       19
       19
       +
         - Content separation: author-managed Markdown in `markdown/` is canonical. Do not edit `public/` — it is generated.

     

       20
       20
       +
         - Theme overrides and custom assets live in `overrides/`; changes there affect build behavior and the site theme.

     

       21
       21
       +
         - The build copies `assets/images/favicon.png` to `public/favicon.ico` after building (see `build.sh` and `bin/build.sh`). Keep favicon at that path.

     

       22
       22
       +
         - Python environment targets Python 3.13 (see `Pipfile`). The repo commonly uses `pipenv` and a `.venv` pattern in local scripts (`bin/localdev.sh`).

     

       23
       23
       +
         - CI: deployments happen via GitLab CI and `bin/deploy.sh` (see `wrangler.jsonc` for Cloudflare Pages configuration).

     

       24
       24
       +
       

     

       25
       25
       +
       - Integration points & external dependencies

     

       26
       26
       +
         - Cloudflare Pages / Workers via `wrangler`/`wrangler.jsonc` (assets directory: `./public`).

     

       27
       27
       +
         - CI builds run on GitLab. Avoid referencing the `docker/` folder — it may be moved to a separate repo.

     

       28
       28
       +
         - `npm` is used only for `wrangler` dev/deploy and Docker convenience scripts (`package.json`).

     

       29
       29
       +
       

     

       30
       30
       +
       - Helpful files to inspect

     

       31
       31
       +
         - Repository README: [README.md](README.md)

     

       32
       32
       +
         - MkDocs config: [mkdocs.yml](mkdocs.yml)

     

       33
       33
       +
         - Build scripts: [build.sh](build.sh) and [bin/build.sh](bin/build.sh)

     

       34
       34
       +
         - CI/deploy: [bin/deploy.sh](bin/deploy.sh) and [wrangler.jsonc](wrangler.jsonc)

     

       35
       35
       +
         - Python deps: [Pipfile](Pipfile) and [requirements.txt](requirements.txt)

     

       36
       36
       +
         -

     

       37
       37
       +
       

     

       38
       38
       +
       - What NOT to do

     

       39
       39
       +
         - Do not edit generated files under `public/` directly — change sources in `markdown/` or `overrides/`.

     

       40
       40
       +
         - Avoid changing `site_dir` or `assets` layout without verifying `wrangler.jsonc` and `bin/deploy.sh` updates.

     

       41
       41
       +
       

     

       42
       42
       +
       - If you need clarification

     

       43
       43
       +
         - Ask the maintainer which mirror/CI (GitLab primary) you want to target before modifying CI configs.

     

       44
       44
       +
       

     

       45
       45
       +
       - Next steps

     

       46
       46
       +
         - If you want, I can expand the CI section with example GitLab job snippets or add examples for contributing patches.

     

       47
       47
       +
       

     

       48
       48
       +
       - Commit attribution

     

       49
       49
       +
         - Adopt the `Assisted-by` commit trailer for AI-assisted changes to comply with attribution policies.

     

       50
       50
       +
         - Required trailer format (commit footer):

     

       51
       51
       +
       

     

       52
       52
       +
       ```

     

       53
       53
       +
       Assisted-by: <Model Name> via <Tool Name>

     

       54
       54
       +
       ```

     

       55
       55
       +
       

     

       56
       56
       +
         - Example:

     

       57
       57
       +
       

     

       58
       58
       +
       ```

     

       59
       59
       +
       Assisted-by: GLM 4.6 via Claude Code

     

       60
       60
       +
       ```

     

       61
       61
       +
       

     

       62
       62
       +
         - Repository also requires Linux DCO sign-off for patches. Ensure commits include `Signed-off-by:` lines in the footer alongside `Assisted-by:` when applicable.

     

       63
       63
       +
       

     

       64
       64
       +
       If any section is unclear or you want deeper examples (e.g., contributing workflow, CI job templates), tell me which area to expand.

     

       65
       65
       +
       

     

       66
       66
       +
       - Example: GitLab CI snippet

     

       67
       67
       +
         - Minimal job that builds the site and publishes to Cloudflare Pages using `wrangler`.

     

       68
       68
       +
       

     

       69
       69
       +
       ```yaml

     

       70
       70
       +
       stages:

     

       71
       71
       +
         - build

     

       72
       72
       +
         - deploy

     

       73
       73
       +
       

     

       74
       74
       +
       build_site:

     

       75
       75
       +
         stage: build

     

       76
       76
       +
         image: node:20-bullseye

     

       77
       77
       +
         script:

     

       78
       78
       +
           - pip install pipenv

     

       79
       79
       +
           - pipenv install --deploy --ignore-pipfile

     

       80
       80
       +
           - pipenv run build

     

       81
       81
       +
         artifacts:

     

       82
       82
       +
           paths:

     

       83
       83
       +
             - public/

     

       84
       84
       +
       

     

       85
       85
       +
       publish_pages:

     

       86
       86
       +
         stage: deploy

     

       87
       87
       +
         image: node:20-bullseye

     

       88
       88
       +
         dependencies:

     

       89
       89
       +
           - build_site

     

       90
       90
       +
         script:

     

       91
       91
       +
           - npm install -g wrangler

     

       92
       92
       +
           - npx wrangler pages publish public --project-name "$CF_PAGES_PROJECT_NAME" --branch "$CI_COMMIT_BRANCH"

     

       93
       93
       +
         only:

     

       94
       94
       +
           - main

     

       95
       95
       +
       ```

     

       96
       96
       +
       

     

       97
       97
       +
         - Notes: set `CF_PAGES_PROJECT_NAME` in CI variables; the repo's `bin/deploy.sh` also contains an example `npx wrangler pages publish` invocation used by CI.