carlos / carloku Public

Download this file

1	# carloku.com
2
3	🤖 Marketing site for Carloku, the hosted CARLOS platform, plus the customer
4	docs at /docs. The marketing pages are hand-written static HTML; the docs are
5	markdown under `src/docs/`, built by Eleventy before shipping.
6
7	**There is a build step, and it decides what the site serves.** Eleventy reads
8	`src/` and writes `_site/`, and `_site/` is what ships — never the repo tree.
9	So: **if a URL should return it, the file goes under `src/`.** A file at the
10	repo root is a repo file, not a page, and will not be served. Anything the site
11	needs — a page, a stylesheet, a font, an image — lives under `src/`, and a
12	non-template asset also needs an `addPassthroughCopy` line in
13	`eleventy.config.js` to be emitted at all.
14
15	```
16	npm install
17	npm run check # build, then gate the rendered output
18	npm run serve # localhost:8080
19	```
20
21	See AGENTS.md for the deploy runbook and the rules of the repo; see
22	https://carlosframework.com for the framework itself.
23