Skip to content

Commit b043753

Browse files
author
clawdiy
committed
docs: initial rewrite for sint.gg post-pivot
Complete Mintlify documentation bundle for docs.sint.gg: - Protocol spec (5 layers, invariants, reference) - Platform docs (pipelines, canon, memory, console, commons, cron) - Face SDK (widget layer, conversation compiler, embed) - Operator guides (anatomy, onboarding, revenue, safety, telemetry, voice) - Research (MCP security, RosClaw) - CI workflows, redirect map, verify scripts Co-Authored-By: clawdiy <clawdiy@sint.ai>
0 parents  commit b043753

73 files changed

Lines changed: 7078 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
jobs:
9+
validate:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-node@v4
14+
with: { node-version: 22 }
15+
- name: Install Mintlify
16+
run: npm i -g mintlify
17+
- name: Validate mint.json
18+
run: mintlify broken-links
19+
- name: Lint MDX
20+
run: |
21+
# Fail CI on any MDX file missing required frontmatter
22+
fail=0
23+
for f in $(find . -name "*.mdx" -not -path "./node_modules/*"); do
24+
if ! head -5 "$f" | grep -q "^title:"; then
25+
echo "::error file=$f::Missing frontmatter 'title:'"
26+
fail=1
27+
fi
28+
done
29+
exit $fail
30+
31+
verify-redirects:
32+
runs-on: ubuntu-latest
33+
needs: validate
34+
if: github.ref == 'refs/heads/main'
35+
steps:
36+
- uses: actions/checkout@v4
37+
- name: Wait for Mintlify deploy
38+
run: sleep 120 # Mintlify auto-deploys on push; give it ~2min
39+
- name: Verify redirects
40+
run: ./scripts/verify-redirects.sh
41+
- name: Verify pages
42+
env:
43+
DOCS_HOST: https://docs.sint.gg
44+
run: |
45+
sudo apt-get install -y jq
46+
./scripts/verify-pages.sh

‎.github/workflows/pr-check.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: PR check
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
check:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with: { node-version: 22 }
14+
- name: Install Mintlify
15+
run: npm i -g mintlify
16+
- name: Broken link check
17+
run: mintlify broken-links
18+
- name: MDX frontmatter check
19+
run: |
20+
fail=0
21+
for f in $(find . -name "*.mdx" -not -path "./node_modules/*"); do
22+
if ! head -5 "$f" | grep -q "^title:"; then
23+
echo "::error file=$f::Missing frontmatter 'title:'"
24+
fail=1
25+
fi
26+
done
27+
exit $fail
28+
- name: Forbid Web3 regressions
29+
run: |
30+
# Block any PR that reintroduces pivot-era terms outside the allowlisted meta-docs.
31+
# Allowlisted files can reference these terms because they exist to explain, redirect, or disclaim.
32+
banned='(tokenomics|\$SINT|airdrop|ASI-1 Mini|Fetch\.ai|Agentverse|Trust Wallet|MetaMask|SINT token|our token)'
33+
allowlist='(origin\.mdx|INK-TEARDOWN\.md|REDIRECT-IMPLEMENTATION\.md|CONTRIBUTING\.md|README\.md|press\.mdx|\.github/workflows/)'
34+
hits=$(grep -RInE "$banned" --include="*.mdx" --include="*.md" --include="*.yml" . | grep -vE ":[^:]*/($allowlist)" || true)
35+
if [ -n "$hits" ]; then
36+
echo "::error::Pivot-era terminology detected outside allowlisted files. Review and either remove or update allowlist in pr-check.yml."
37+
echo "$hits"
38+
exit 1
39+
fi

‎APPLY.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# APPLY.md — How to ship this
2+
3+
**Order of operations.** Do these in sequence; each step builds on the previous.
4+
5+
## 1. Create the repo and push
6+
7+
```bash
8+
# Create github.com/sint-ai/sint-docs (private first, flip to public after verify)
9+
cd /path/to/working-dir
10+
git init sint-docs
11+
cd sint-docs
12+
13+
# Copy the bundle contents
14+
cp -r /path/to/this/bundle/. .
15+
16+
git add .
17+
git commit -S -m "docs: initial rewrite for sint.gg post-pivot"
18+
git remote add origin git@github.com:sint-ai/sint-docs.git
19+
git push -u origin main
20+
```
21+
22+
## 2. Connect Mintlify
23+
24+
- Mintlify dashboard → **New deployment** → **GitHub** → pick `sint-ai/sint-docs`
25+
- Set custom domain to `docs.sint.gg`
26+
- Mintlify will give you a CNAME target — add it in your DNS provider (replaces whatever `docs.sint.gg` currently points to)
27+
- Wait for DNS + SSL (~5 min)
28+
29+
## 3. Verify the new site
30+
31+
```bash
32+
# In the repo:
33+
./scripts/verify-pages.sh
34+
# All pages in mint.json should return 200
35+
```
36+
37+
## 4. Apply legacy redirects
38+
39+
Pick one path from `REDIRECT-IMPLEMENTATION.md`:
40+
- **Option 1 (easiest):** Already configured in `mint.json`. Nothing to do beyond step 2.
41+
- **Option 2 (most robust):** Cloudflare Bulk Redirects. See the CSV in `REDIRECT-IMPLEMENTATION.md` §Option 2.
42+
43+
Then verify:
44+
45+
```bash
46+
./scripts/verify-redirects.sh
47+
```
48+
49+
Expected: 19 redirects, 0 misses.
50+
51+
## 5. Tear down `ink.sint.gg`
52+
53+
Follow `INK-TEARDOWN.md`. Recommended: Option A (hard teardown).
54+
55+
## 6. Request Google re-crawl
56+
57+
From Google Search Console:
58+
- Submit new sitemap: `https://docs.sint.gg/sitemap.xml`
59+
- Request indexing on the top-20 new pages (origin, overview pages, flagship Operator pages)
60+
- Use the **Removals** tool on the top-20 old URLs (the ones `site:docs.sint.gg` currently returns)
61+
62+
## 7. Sweep inbound references
63+
64+
```bash
65+
# From your main dev workspace
66+
for repo in ~/sint-ai-workspace/*; do
67+
grep -RIn "docs.sint.gg/whitepaper\|docs.sint.gg/tokenomics\|docs.sint.gg/airdrop\|docs.sint.gg/asi\|docs.sint.gg/mcp-marketplace\|docs.sint.gg/sintasibridge\|ink.sint.gg" "$repo" 2>/dev/null
68+
done
69+
```
70+
71+
Replace any hit with the new canonical path (or remove if no longer relevant).
72+
73+
## 8. Enable CI
74+
75+
After the first green deploy, turn on branch protection on `main`:
76+
- Require PR review (1 reviewer)
77+
- Require status checks: `pr-check`, `validate`
78+
- Require signed commits
79+
80+
## 9. Ship log entry
81+
82+
Add a single line to the ship log:
83+
84+
> Docs rebuild shipped. `docs.sint.gg` now reflects the post-pivot SINT Labs (Protocol + Operators + Platform + Face). 19 legacy paths 301 to `/origin` or new canonical destinations. `ink.sint.gg` decommissioned. Google re-crawl requested.
85+
86+
---
87+
88+
## What you get
89+
90+
72 files. ~33,000 words of production MDX content. Every page in the ecosystem is covered: Protocol (5 layers + 5 invariants + reference), Operators (6 flagship + anatomy + safety envelope + telemetry), Platform (Console, Commons, Memory, Cron, Canon, Pipelines — all with sub-pages), Face (5 pages), Research (2 papers), Resources (changelog, trust, press, support). Plus: the ink teardown procedure, the redirect implementation guide with three host-specific options, two verify scripts, and two CI workflows.
91+
92+
## What still requires you
93+
94+
- DNS change pointing `docs.sint.gg` at Mintlify
95+
- Cloudflare Bulk Redirect list (if you go with Option 2)
96+
- ink.sint.gg teardown (DNS change + host-side cleanup per INK-TEARDOWN.md)
97+
- Google Search Console re-indexing request
98+
- Domain-level verification of SSO/OIDC if you later wire that up for Console

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to sint-docs
2+
3+
Docs for [docs.sint.gg](https://docs.sint.gg).
4+
5+
## Setup
6+
7+
```bash
8+
npm i -g mintlify
9+
git clone https://github.com/sint-ai/sint-docs
10+
cd sint-docs
11+
mintlify dev # → http://localhost:3000
12+
```
13+
14+
## Adding a page
15+
16+
1. Create the `.mdx` file under the appropriate directory.
17+
2. Add YAML frontmatter with at least `title` and `description`.
18+
3. Add the page path to `mint.json` `navigation`.
19+
4. `mintlify dev` should hot-reload it.
20+
21+
## Required frontmatter
22+
23+
```yaml
24+
---
25+
title: "Page title (short)"
26+
description: "One-sentence description shown on cards and in search."
27+
---
28+
```
29+
30+
## Style
31+
32+
- Short paragraphs. Three sentences is often enough.
33+
- No "we are excited to announce." Just announce.
34+
- Code samples are TypeScript unless the content is explicitly cross-language.
35+
- Tables over prose when comparing.
36+
- Link to every related page from each page. Don't leave dead ends.
37+
38+
## Anti-regression rules (enforced in CI)
39+
40+
- **Pivot-era terminology** (`tokenomics`, `$SINT`, `airdrop`, `ASI-1 Mini`, `Fetch.ai`, `Agentverse`, `Trust Wallet`, `MetaMask`, "SINT token", "our token") is allowed **only** in `origin.mdx` and `INK-TEARDOWN.md`. Anywhere else, CI fails.
41+
- **OpenClaw** must not appear in any outbound-shaped content. It can be mentioned on `founder`-style pages and the `trust.mdx` page as proof of dogfooding, nowhere else.
42+
- Every `.mdx` file must have `title:` in its frontmatter. CI enforces.
43+
- `mintlify broken-links` must pass.
44+
45+
## Reviews
46+
47+
One maintainer review for content changes. Two for `mint.json` structural changes or `origin.mdx` edits.
48+
49+
## Deploy
50+
51+
`main` auto-deploys via the Mintlify GitHub app. After deploy, `.github/workflows/deploy.yml` runs `verify-redirects.sh` and `verify-pages.sh` against `https://docs.sint.gg`.
52+
53+
## Security
54+
55+
Never include tokens, secrets, or per-tenant data in example code. Use placeholders (`acme`, `your-tenant`, `...`).

0 commit comments

Comments
 (0)