Skip to content

Commit dc3c514

Browse files
docs(readme): lead with agent value prop + LLM index; fix stale layout (#23)
- Open with the instanode.dev value prop (one-call infra for AI agents) and surface llms.txt / the /.md mirrors so this public repo is discoverable to LLM indexers and humans, not just an internal build-input note. - Fix stale layout block: use-cases/ and docs/ now exist (were marked 'coming'), added pages/; corrected use-cases from .json to per-file .md. - Reframe instanode-web as the web app repo (not just 'dashboard'). Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 069f3e4 commit dc3c514

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
11
# instanode.dev — public content
22

3-
Source of truth for the marketing site (https://instanode.dev) content.
3+
Source of truth for the public content of **[instanode.dev](https://instanode.dev)**
4+
zero-friction developer infrastructure for AI agents. Provision a real Postgres, pgvector,
5+
Redis, MongoDB, NATS queue, or S3 bucket (and deploy your app) with a single HTTP call.
6+
No account, no Docker, no setup. Free anonymous tier.
47

5-
The dashboard repo (`InstaNode-dev/instanode-web`) clones this repo into
6-
its `.content/` directory at build time and inlines the markdown into
7-
the static HTML via Vite's `import.meta.glob` raw imports. The same
8-
flow runs in `npm run dev` so authors get hot reload on edits in a
9-
local clone.
8+
This repo holds the marketing copy, blog posts, use cases, and docs that ship to
9+
https://instanode.dev — plus **[`llms.txt`](./llms.txt)**, the LLM-friendly index that lets
10+
AI coding agents (Claude, Cursor, Copilot, Windsurf) discover and use the platform. The live
11+
copy is served at https://instanode.dev/llms.txt, with a `/.md` mirror of every page and the
12+
full text at https://instanode.dev/llms-full.txt.
13+
14+
The web app repo (`InstaNode-dev/instanode-web`) clones this repo into its `.content/`
15+
directory at build time and inlines the markdown into the static HTML via Vite's
16+
`import.meta.glob` raw imports. The same flow runs in `npm run dev` so authors get hot
17+
reload on edits in a local clone.
1018

1119
## Layout
1220

1321
```
1422
.
23+
├── llms.txt LLM-friendly platform index (served at /llms.txt)
1524
├── blog/
16-
│ ├── <slug>.md one post per file; filename = URL slug
17-
│ └── ...
18-
├── use-cases.json (slice B — coming)
19-
└── docs/ (slice C — coming)
20-
└── <section>.md
25+
│ └── <slug>.md one post per file; filename = URL slug
26+
├── use-cases/
27+
│ └── <slug>.md one use case per file; filename = URL slug
28+
├── docs/
29+
│ └── <section>.md quickstart, services, deploy, stacks, limits, auth, …
30+
└── pages/
31+
└── <name>.md top-level marketing pages (home, pricing, for-agents, status)
2132
```
2233

2334
## Blog post format

0 commit comments

Comments
 (0)