Repository navigation
Commit ff8fb4e
authored
docs: rebuild agentsview.io as a tiered marketing and documentation site (#1568)
Rebuilds agentsview.io as a three-tier site: a hand-written marketing landing page at `/`, a nine-stop guided tour at `/guide/`, and the Zensical documentation moved under `/docs/`. The goal is to pitch AgentsView as the system of record for agent session intelligence — an always-on daemon with monitoring, cost accounting, search, recall, and agent-facing interfaces — rather than a desktop session browser.
## What the site does now
- **Marketing tier** (`docs/website/`): landing page with a two-column hero (headline, install command, and a framed dashboard screenshot), nine numbered sections (record, observe, account, understand, remember, feed back, share, own, start), 56 agent-harness chips, live GitHub stars/version via the API with a cached fallback, and a lightbox for screenshots. `/guide/` walks the session intelligence loop across nine stops. Dark blue theme with vendored Inter and JetBrains Mono (OFL licenses included), a custom AV favicon, and a 404 page.
- **Docs tier**: Zensical builds under `/docs/` via `site_url`, with `docs/index.md` rewritten as a docs landing page (mental model, architecture, privacy). All 28 doc pages' absolute links are rewritten with the `/docs/` prefix. The `docs/agents/` contributor guides are no longer published (they were accidentally reachable before).
- **Machine-readable tier**: every route ships a Markdown twin (`/index.md`, `/guide.md`, `/docs/<page>.md`) advertised by a `rel="alternate" type="text/markdown"` head link and footer links, and `/llms.txt` lists the full twin set.
## Redirects and contracts
`docs/vercel.json` carries 61 permanent redirects covering every legacy route: 28 old root pages (both `/<page>/` and `/<page>.md`) to their `/docs/` locations, asset wildcards, and the pre-existing `/postgresql/`, `/insights/`, and `/architecture/` aliases. The two temporary install-script redirects are unchanged.
The validators enforce the new structure: `check_built_site.py` verifies every route's Markdown twin, alternate link, metadata, and bidirectional `llms.txt` coverage; `check_vercel_redirects.py` now also rejects unexpected redirect entries; `scripts/docs_assets_test.go` covers the assembled three-tier output, including the sitemap shipping at both `/sitemap.xml` and `/docs/sitemap.xml` (Zensical's instant navigation fetches the latter and silently degrades if it 404s).
## Tradeoffs and limits
- The marketing tier is plain HTML/CSS/JS assembled by `zensical-docs.sh` — no new build toolchain or Node dependency.
- Vercel configuration is untouched: the root directory stays `docs/`, output stays `site/`, and deploys remain manual via `make docs-deploy`.
- The docs tier still uses the Zensical default favicon; only the marketing tier has the AV mark.
## Where to look
- `docs/zensical-docs.sh` — the site assembly: docs build into `site/docs/`, then the website tier, `llms.txt`, and sitemap copies are placed at the root.
- `docs/website/index.html` and `docs/website/styles/site.css` — the landing page and theme.
- `docs/scripts/check_built_site.py` — the contracts that keep the twin/llms.txt/redirect structure honest.
Preview locally with `make docs-build && make docs-preview`.
Co-authored-by: Wes McKinney <wesm@users.noreply.github.com>1 parent f64e22e commit ff8fb4e
55 files changed
Lines changed: 3399 additions & 854 deletions
File tree
- docs
- javascripts
- overrides
- scripts
- stylesheets
- website
- fonts
- licenses
- guide
- scripts
- styles
- scripts
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
552 | 552 | | |
553 | 553 | | |
554 | 554 | | |
| 555 | + | |
| 556 | + | |
| 557 | + | |
555 | 558 | | |
556 | 559 | | |
557 | 560 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
6 | 20 | | |
7 | 21 | | |
8 | 22 | | |
9 | | - | |
10 | | - | |
11 | | - | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
12 | 29 | | |
13 | 30 | | |
14 | | - | |
| 31 | + | |
| 32 | + | |
15 | 33 | | |
16 | | - | |
| 34 | + | |
| 35 | + | |
17 | 36 | | |
18 | 37 | | |
19 | 38 | | |
| |||
52 | 71 | | |
53 | 72 | | |
54 | 73 | | |
55 | | - | |
| 74 | + | |
| 75 | + | |
56 | 76 | | |
57 | 77 | | |
58 | 78 | | |
59 | 79 | | |
60 | 80 | | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
61 | 89 | | |
62 | 90 | | |
63 | 91 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
| 67 | + | |
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
| |||
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | | - | |
| 85 | + | |
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| |||
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
105 | | - | |
| 105 | + | |
106 | 106 | | |
107 | 107 | | |
108 | 108 | | |
| |||
117 | 117 | | |
118 | 118 | | |
119 | 119 | | |
120 | | - | |
| 120 | + | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
| 123 | + | |
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
| |||
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
134 | | - | |
| 134 | + | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
| 137 | + | |
138 | 138 | | |
139 | 139 | | |
140 | 140 | | |
| |||
167 | 167 | | |
168 | 168 | | |
169 | 169 | | |
170 | | - | |
171 | | - | |
| 170 | + | |
| 171 | + | |
172 | 172 | | |
173 | 173 | | |
174 | 174 | | |
| |||
247 | 247 | | |
248 | 248 | | |
249 | 249 | | |
250 | | - | |
251 | | - | |
| 250 | + | |
| 251 | + | |
252 | 252 | | |
253 | | - | |
| 253 | + | |
254 | 254 | | |
0 commit comments