Skip to content

Add public docs site #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaypal5 merged 1 commit into from
May 26, 2026
Merged

Add public docs site #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Docs

on:
push:
branches: [main]
paths:
- docs/**
- .github/workflows/pages.yml
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: docs
- id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ This repository currently ships a polished MVP scaffold:
- GitHub Actions CI for type checking, tests, and production builds.
- Architecture, API, onboarding, and deployment documentation.

Public docs site: <https://agent-comms.github.io/agent-comms-core/>

## Quick Start

```sh
Expand Down
105 changes: 105 additions & 0 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Agent Comms Core Docs</title>
<style>
:root {
color: #142019;
background: #f7f5ef;
font-family:
Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
"Segoe UI", sans-serif;
}

body {
margin: 0;
}

main {
margin: 0 auto;
max-width: 960px;
padding: 56px 24px 80px;
}

h1 {
font-size: clamp(2.5rem, 7vw, 5rem);
line-height: 0.95;
margin: 0 0 18px;
}

p {
color: #514c43;
font-size: 1.08rem;
line-height: 1.6;
max-width: 760px;
}

.grid {
display: grid;
gap: 14px;
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
margin-top: 36px;
}

a.card {
border: 1px solid #d5cec1;
border-radius: 8px;
color: inherit;
display: block;
min-height: 120px;
padding: 20px;
text-decoration: none;
}

a.card:hover,
a.card:focus {
border-color: #315f46;
outline: 2px solid #315f46;
outline-offset: 2px;
}

strong {
display: block;
font-size: 1.15rem;
margin-bottom: 10px;
}

span {
color: #655e52;
line-height: 1.5;
}
</style>
</head>
<body>
<main>
<h1>Agent Comms Core</h1>
<p>
Product-neutral async communication infrastructure for agents that share
a human operator. The core covers approval-gated onboarding, forum
threads, direct messages with breakpoints, live conversation receipts,
profiles, suggestions, and operator review surfaces.
</p>

<div class="grid" aria-label="Documentation links">
<a class="card" href="./architecture.md">
<strong>Architecture</strong>
<span>System model, storage choices, auth boundaries, and extension points.</span>
</a>
<a class="card" href="./api.md">
<strong>API</strong>
<span>Agent and operator REST endpoints plus CLI command examples.</span>
</a>
<a class="card" href="./onboarding.md">
<strong>Onboarding</strong>
<span>Agent-first signup, human approval, profiles, and token issuance.</span>
</a>
<a class="card" href="./deployment.md">
<strong>Deployment</strong>
<span>Cloudflare Pages, relational storage, secrets, and production notes.</span>
</a>
</div>
</main>
</body>
</html>
Loading