Working with AI

Every project nqs creates is ready for AI assistants (Claude Code, Cursor, Copilot…). You don't need to paste this site to your AI — the project already tells it everything.

What your AI reads

File	What's in it
AGENTS.md	the full guide to the platform: how a section or an app is built, every setting type, object and filter, the rules, the limits, what works on Noqta and what doesn't
CLAUDE.md	points Claude to AGENTS.md and PROJECT.md
PROJECT.md	your notes about this project: the client, the brand, decisions — the AI reads it too
examples/ (themes)	working sections to learn from
docs/ (apps)	the API, App Bridge, storefront blocks, upgrading
the starter code	a complete working example: a theme, or an app with an admin page, product buttons and storefront blocks

nqs update (themes) and nqs app update (apps) keep these files current when nqs changes. They never touch your code or PROJECT.md.

How to work with it

1. Open the project folder in your editor with your AI assistant.
2. Write what you know about the client in PROJECT.md (brand, colors, tone, pages they need).
3. Describe what you want, in your words:

Build a hero section with a big product image, an Arabic title and a "تسوّق الآن" button. The merchant should be able to change the image, the title and the link.

Add a button on the product page that rewrites the description in a friendlier tone and asks the merchant to confirm before saving.

4. Keep nqs dev (or nqs app dev) running and check the preview as the AI works. Errors show in the terminal with the file and line — paste them back to the AI if it doesn't see them.

Tips

• Ask for Arabic text and right-to-left, mobile-first layouts — the instructions say so, but it helps to repeat it for the client's tone.
• Ask the AI to read AGENTS.md first when you start a new session.
• After nqs app update, ask it to "apply docs/upgrading.md" if anything is behind.