# Customize Lumio With AI

## Customize Lumio With AI

**Skill level:** Beginner · **Works with:** Claude, Cursor, GitHub Copilot, Gemini, Windsurf, Codex, ChatGPT, and any other assistant

Lumio is built so that an AI assistant can change it safely. Three things make that work:

1. **Content is separate from code.** Almost every change is an edit to a Markdown, TOML, or JSON file: your site details in `src/config/config.toml`, services in `src/content/services/`, case studies in `src/content/case-studies/`, the homepage sections in `src/content/sections/`. AI tools do this kind of task well.
2. **Content files explain themselves.** Section files list their options and allowed values in comments next to each key, so the assistant can see what is possible without guessing.
3. **The theme ships instruction files for AI tools.** They describe the folder structure and the rules for changing it. Most AI coding tools load them when you open the project folder.

### The AI Instruction Files In Lumio
Lumio ships four instruction files at the top of the theme folder and three in hidden folders. Folders that start with a dot (`.github/`, `.cursor/`, `.windsurf/`) are hidden by default in Finder and File Explorer; your code editor shows them. You don't need to edit any of these files. They are there for your assistant. Each edition ships its own copy, written for that edition.

| File                                    | Read by                                                                                                | What it contains                                                                                                                                 |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `AGENTS.md`                             | OpenAI Codex, Cursor, Windsurf, GitHub Copilot, and other tools that follow the `AGENTS.md` convention | The full rules: project map, content model, sections and page overrides, header and footer variants, menus, styling, RTL, languages, motion, forms, editions, and the limits of the checks |
| `SKILLS.md`                             | Any assistant you point to it                                                                          | Step-by-step recipes: add a section or page, switch a variant, edit menus, add or remove a language, make something work right to left, rebrand, add an icon, verify |
| `CLAUDE.md`                             | Claude Code                                                                                            | Imports `AGENTS.md` (the `@AGENTS.md` line), then a short list of the most important rules                                                       |
| `GEMINI.md`                             | Gemini CLI                                                                                             | The same as `CLAUDE.md`, for Gemini                                                                                                              |
| `.github/copilot-instructions.md`       | GitHub Copilot (coding agent, VS Code, CLI)                                                            | A short summary that points to `AGENTS.md` and `SKILLS.md`                                                                                       |
| `.cursor/rules/theme-architecture.mdc`  | Cursor (always on)                                                                                     | The architecture rules, with a pointer to `AGENTS.md`                                                                                            |
| `.windsurf/rules/theme-architecture.md` | Windsurf (always on)                                                                                   | The same rules for Windsurf                                                                                                                      |

The `.vscode/` folder holds editor settings and recommended extensions, not AI rules.

Chat assistants in a browser (ChatGPT, Claude, Gemini) can't read your folder. You paste `AGENTS.md` into the conversation yourself: see [AI Workflow](/lumio/ai-customization/ai-workflow/).

These files tell an assistant to:

- keep editable text, links, images, buttons, and options in `src/content/`, not in components
- make every change in every language: each language folder under `src/content/`, `src/i18n/<language>.json`, and `src/config/menu.<language>.json`
- change a section on one page with the `content` prop in that page's route, keeping the values in the page's own content file
- pick a header and footer per page with the `header` and `footer` props on `<Base>`, not by editing `Base.astro`
- reuse Lumio's `Button.astro`, `Icons.astro`, `OptimizedImage.astro`, `SectionTitle`, and `SectionBadge`, and the color tokens in `src/styles/theme.css`
- use logical CSS classes (`ms`, `pe`, `start`, `text-start`) so every page still works right to left in Arabic
- read languages through `src/config/language.json`, never from a hard-coded language code
- never invent client names, testimonials, case-study results, metrics, or prices
- check changed pages at about 375 px and 1280 px wide, and at `/ar/`
- run `npm run astro-check` when they finish

### Two Ways To Work With AI
<CardGrid>
  <Card title="AI that can open your files" icon="laptop">
    Cursor, Windsurf, Claude Code, GitHub Copilot in VS Code, Gemini CLI, Codex.
    Open the Lumio project folder in the tool and describe the change. It reads
    the instruction files, edits the files, and can run the checks.
    **This is the best way to work.**
  </Card>
  <Card title="Chat assistants" icon="comment">
    ChatGPT, Claude, or Gemini in the browser. They can't see your project, so
    you paste `AGENTS.md` and the file you want changed, and copy the answer
    back. Fine for rewriting text, one file at a time.
  </Card>
</CardGrid>

### What AI Is Great At In Lumio
- Rewriting the sample copy for your company, in every language
- Filling collections: services, case studies, blog posts, team, testimonials, FAQ, legal pages
- Setting your packages, prices, and what each one includes
- Choosing one of the three homepages, and reordering its sections
- Switching a page's header (one, two, three) and footer (one, two)
- Changing menus, including the mega menu, the topbar, and the footer columns
- Translating the site, adding a language, or turning one off
- Explaining an error message and fixing it

### What To Check Yourself
- **Case-study results.** Every number and client name in `src/content/case-studies/` is made up. These are the claims a prospect checks first: replace them with results you can back up, and make sure you are allowed to name the client.
- **Facts.** AI writes convincing copy, and it can invent testimonials, awards, team sizes, years in business, and certifications you never gave it. Check every quote, number, and promise before you publish.
- **Prices.** The packages in `src/content/sections/<language>/pricing-section.md` are samples. Give the assistant your real figures, and read the result back.
- **Placeholder bodies.** Service, case-study, and post bodies ship with placeholder text. Replace every one you keep.
- **`site.baseUrl`.** It ships pointing at the theme's demo site, and an ordinary build warns about it. Change it before you launch.
- **Longer names and labels.** A company name, button label, or menu item longer than the sample can wrap or crowd the layout. Check the header, the topbar, the mega menu, and the hero at about 375 px.
- **Arabic and French.** Both are machine translated in the sample content. Open `/ar/` after any layout change and have the text reviewed by a native speaker. A single entry such as a post with no file in a language has no URL in that language.
- **The result in the browser.** `npm run astro-check` validates only `pages`, `services`, `blog`, `case-studies`, `team`, and `testimonial`. A wrong value in a `sections`, `homepage`, `about`, `contact`, `faq`, `pricing`, `author`, or `features` file passes the check; in the checked collections an unknown key is silently dropped; and `menu.<lang>.json`, `src/i18n/<lang>.json`, and `config.toml` aren't validated at all.
- **Forms.** Send one contact message and one newsletter signup on the live site, and check that they arrive. The blog comment form is switched off by default.

<Aside type="tip" title="Five rules for good results">
  1. One task per request. "Change the hero" works better than "redo the site".
  2. Name the file when you know it. Every page in these docs tells you which one.
  3. Say what must stay the same: "keep every key and option, only change the text".
  4. Ask for every language, or say which languages you use.
  5. Save a checkpoint first (a git commit or a copy of the folder), so any change can be undone.
</Aside>

Ready? Go to the [Prompt Library](/lumio/ai-customization/prompt-library/) for copy-paste prompts.