Browse Source

Format project documentation and homepage

main
Jonathan Hinkel 2 months ago
parent
commit
851988aa36
  1. 2
      README.md
  2. 16
      src/routes/+page.svelte

2
README.md

@ -25,7 +25,7 @@ Open [`/demo/realtime`](http://localhost:5173/demo/realtime) for the realtime se
## Documentation
| Subsystem | Doc |
| ------------------------------------------------------------- | --------------------------------------------------- |
| -------------------------------------------------------- | ---------------------------------------------------- |
| Architecture overview and module layering | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) |
| Realtime session management | [docs/REALTIME_SESSION.md](docs/REALTIME_SESSION.md) |
| Tool calling (server- and client-executed) | [docs/TOOLS.md](docs/TOOLS.md) |

16
src/routes/+page.svelte

@ -4,19 +4,23 @@
<h1>webavatar-core</h1>
<p>
A base SvelteKit project for webavatar client projects. It provides the reusable
infrastructure those projects would otherwise reimplement from scratch — session management,
auth tokens, and the realtime model connection — as a foundation to branch from, not a finished
product.
A base SvelteKit project for webavatar client projects. It provides the reusable infrastructure
those projects would otherwise reimplement from scratch — session management, auth tokens, and the
realtime model connection — as a foundation to branch from, not a finished product.
</p>
<h2>Demos</h2>
<ul>
<li><a href={resolve('/demo/realtime')}>/demo/realtime</a> — realtime session reference wiring</li>
<li>
<a href={resolve('/demo/realtime')}>/demo/realtime</a> — realtime session reference wiring
</li>
<li>
<a href={resolve('/demo/humanoid')}>/demo/humanoid</a> — humanoid avatar-state derivation
</li>
</ul>
<h2>Docs</h2>
<p>See <code>docs/ARCHITECTURE.md</code> in the repo for the full architecture map, or the README for getting started.</p>
<p>
See <code>docs/ARCHITECTURE.md</code> in the repo for the full architecture map, or the README for getting
started.
</p>

Loading…
Cancel
Save