Rebuild guidance wiki as a unified SaaS workspace

This commit is contained in:
2026-10-29 20:26:24 +08:00
parent f490543853
commit 0d8aacb9a2
25 changed files with 5778 additions and 208 deletions
+359 -23
View File
@@ -1,24 +1,360 @@
'use client';
import { useEffect, useState, type FormEvent } from 'react';
export default function AccountPage() {
const [mode,setMode]=useState('login');const [user,setUser]=useState<{email:string}|null>(null);
const [message,setMessage]=useState('');const [busy,setBusy]=useState(false);const [token,setToken]=useState('');
async function refresh(){try{const r=await fetch('/api/account/session');const data=await r.json();if(r.ok)setUser(data.user);else setMessage(data.error);}catch{setMessage('暂时无法连接账户服务');}}
useEffect(()=>{void refresh();const u=new URL(window.location.href);setToken(u.searchParams.get('verify')||'');if(u.searchParams.has('verify'))window.history.replaceState({},'', '/account');},[]);
async function action(name:string,body:object={}) {setBusy(true);setMessage('');try{const r=await fetch('/api/account/'+name,{method:'POST',headers:{'Content-Type':'application/json'},body:JSON.stringify(body)});const d=await r.json();setMessage(d.error||d.message||'操作成功');if(r.ok){if(name==='verify')setToken('');await refresh();}}catch{setMessage('网络异常,请稍后重试');}finally{setBusy(false);}}
function submit(e:FormEvent<HTMLFormElement>){e.preventDefault();const f=new FormData(e.currentTarget);void action(mode,{email:f.get('email'),password:f.get('password')});}
const button={padding:'12px 20px',border:'1px solid #394b43',borderRadius:12,cursor:'pointer',background:'#173d30',color:'white'};
return <main style={{maxWidth:540,margin:'8vh auto',padding:28,fontFamily:'system-ui',color:'#18382b'}}>
<a href="/">← 返回知识站</a><h1 style={{fontSize:36,marginTop:32}}>你的知识站账户</h1>
<p>用邮箱保存你的身份。邮箱账户与管理员动态码权限独立。</p>
{token&&<section style={{padding:20,background:'#f1f5ef',borderRadius:16}}><h2>确认邮箱验证</h2><p>点击后完成验证,再使用邮箱和密码登录。</p><button disabled={busy} style={button} onClick={()=>void action('verify',{token})}>确认验证邮箱</button></section>}
{user?<section><h2>已登录</h2><p>{user.email}</p><p>邮箱已验证</p><button style={button} disabled={busy} onClick={()=>void action('logout')}>退出登录</button></section>:<>
<nav style={{display:'flex',gap:10,margin:'24px 0'}}>{[['login','登录'],['register','注册'],['resend','重发验证邮件']].map(([v,label])=><button key={v} disabled={busy} aria-pressed={mode===v} style={{...button,background:mode===v?'#173d30':'#65776c'}} onClick={()=>{setMode(v);setMessage('');}}>{label}</button>)}</nav>
<form onSubmit={submit} style={{display:'grid',gap:16}}>
<label>邮箱<input style={{display:'block',width:'100%',padding:12,border:'1px solid #b4bfb7',borderRadius:8}} required type="email" name="email" maxLength={254} autoComplete="email" /></label>
<label>密码<input style={{display:'block',width:'100%',padding:12,border:'1px solid #b4bfb7',borderRadius:8}} required type="password" name="password" minLength={12} maxLength={256} autoComplete={mode==='register'?'new-password':'current-password'} /></label>
<small>密码至少 12 个字符。注册后需先验证邮箱;验证链接有效期 30 分钟。</small>
<button style={button} disabled={busy} type="submit">{busy?'处理中…':mode==='login'?'登录':mode==='register'?'创建账户':'重发验证邮件'}</button></form></>}
<p role="status" style={{lineHeight:1.7,marginTop:24}}>{message}</p>
</main>;
import Link from "next/link";
import { useRouter } from "next/router";
import { useEffect, useState, type FormEvent } from "react";
import {
ArrowRight,
BookOpen,
CheckCircle2,
Eye,
EyeOff,
GitBranch,
Link2,
LogOut,
MailCheck,
Waypoints,
} from "lucide-react";
import GuidanceShell, { useGuidanceAccount } from "@/components/GuidanceShell";
import { Notice } from "@/components/GuidanceUI";
import s from "@/styles/guidance.module.css";
type Mode = "login" | "register" | "resend";
function localNext(value: string | string[] | undefined) {
if (
typeof value !== "string" ||
!value.startsWith("/") ||
value.startsWith("//") ||
/[\\\u0000-\u001f]/.test(value)
)
return "/write";
try {
const url = new URL(value, "https://local.invalid");
return url.origin === "https://local.invalid"
? url.pathname + url.search + url.hash
: "/write";
} catch {
return "/write";
}
}
export default function AccountPage() {
return (
<GuidanceShell title="邮箱账户">
<AccountContent />
</GuidanceShell>
);
}
function AccountContent() {
const account = useGuidanceAccount(),
router = useRouter();
const [mode, setMode] = useState<Mode>("login"),
[email, setEmail] = useState(""),
[password, setPassword] = useState(""),
[showPassword, setShowPassword] = useState(false);
const [busy, setBusy] = useState(false),
[token, setToken] = useState(""),
[feedback, setFeedback] = useState<{
tone: "success" | "error";
text: string;
} | null>(null);
useEffect(() => {
const url = new URL(window.location.href);
const value = url.searchParams.get("verify");
if (value) {
setToken(value);
url.searchParams.delete("verify");
window.history.replaceState({}, "", url.pathname + url.search + url.hash);
}
}, []);
async function action(name: Mode | "verify" | "logout", body: object = {}) {
if (busy) return;
setBusy(true);
setFeedback(null);
try {
const response = await fetch("/api/account/" + name, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(body),
});
const data = await response.json();
if (!response.ok) throw Error(data.error || "暂时无法完成操作,请重试");
if (name === "verify") {
setToken("");
setMode("login");
setFeedback({ tone: "success", text: "邮箱已验证,现在可以登录。" });
} else if (name === "login") {
setPassword("");
setFeedback({ tone: "success", text: "登录成功,欢迎回到织页。" });
} else if (name === "logout") {
setPassword("");
setFeedback({ tone: "success", text: "已退出登录。" });
} else
setFeedback({
tone: "success",
text:
data.message ||
"如果信息符合条件,验证邮件已发送。请检查收件箱和垃圾邮件。",
});
await account.refresh();
} catch (e) {
setFeedback({
tone: "error",
text: e instanceof Error ? e.message : "网络异常,请稍后重试",
});
} finally {
setBusy(false);
}
}
function submit(event: FormEvent<HTMLFormElement>) {
event.preventDefault();
void action(mode, { email, password });
}
function switchMode(value: Mode) {
setMode(value);
setFeedback(null);
}
return (
<div className={s.accountLayout}>
<section className={s.accountIntro}>
<span className={s.accountSymbol}>
<Waypoints size={28} />
</span>
<span className={s.eyebrow}>YOUR KNOWLEDGE, CONNECTED</span>
<h1>
让有用的知识,
<br />
成为下一次行动的起点。
</h1>
<p>
用邮箱建立你的知识空间。把工作方法写成独立文档,让 Agent
在需要的时候找到它。
</p>
<div className={s.accountFeatures}>
<div>
<BookOpen size={18} />
<div>
<strong>每篇文档,都能独立使用</strong>
<p>从当前任务出发,无需加载整个集合。</p>
</div>
</div>
<div>
<GitBranch size={18} />
<div>
<strong>每次更新,都有固定版本</strong>
<p>历史引用保持可读,修改始终有迹可循。</p>
</div>
</div>
<div>
<Link2 size={18} />
<div>
<strong>知识之间,按条件连接</strong>
<p>需要更多背景时,再沿有用的链接继续阅读。</p>
</div>
</div>
</div>
</section>
<section className={s.authCard} aria-label="邮箱账户">
<h2>
{account.user
? "你的账户"
: mode === "register"
? "创建你的账户"
: mode === "resend"
? "重发验证邮件"
: "欢迎回来"}
</h2>
<p className={s.authDescription}>
{account.user
? "已准备好发布和管理你的独立文档。"
: mode === "register"
? "验证邮箱后,就可以发布第一篇文档。"
: mode === "resend"
? "输入注册时的邮箱和密码,重新获取验证链接。"
: "使用邮箱与密码登录,继续你的知识工作。"}
</p>
{token && (
<section className={s.verificationCard}>
<h3>
<MailCheck size={17} />
确认验证邮箱
</h3>
<p>验证链接有效期为 30 分钟。确认后,再使用邮箱与密码登录。</p>
<button
type="button"
className={s.primaryButton}
disabled={busy}
onClick={() => void action("verify", { token })}
>
{busy ? "正在验证…" : "确认验证邮箱"}
</button>
</section>
)}
{feedback && <Notice tone={feedback.tone}>{feedback.text}</Notice>}
{account.error && (
<Notice tone="error">
{account.error}{" "}
<button
type="button"
className={s.textLink}
onClick={() => void account.refresh()}
>
重新连接
</button>
</Notice>
)}
{account.loading ? (
<div className={s.accountLoading} aria-busy="true">
正在检查账户状态…
</div>
) : account.user ? (
<>
<div className={s.loggedUser}>
<span className={s.avatar}>
{account.user.email.slice(0, 1).toUpperCase()}
</span>
<div>
<strong>{account.user.email}</strong>
<span className={s.verifiedBadge}>
<CheckCircle2 size={13} />
邮箱已验证
</span>
</div>
</div>
<div className={s.accountInfo}>
<p>
<strong>你的内容,由你管理。</strong>
<br />
你可以发布文档、创建新版本,以及撤下自己的内容。公开文档的固定历史版本会继续保留。
</p>
</div>
<Link
className={s.primaryButton}
href={localNext(router.query.next)}
>
继续使用织页
<ArrowRight size={15} />
</Link>
<div className={s.authSecondary}>
<button
type="button"
disabled={busy}
onClick={() => void action("logout")}
>
<LogOut size={12} /> 退出登录
</button>
</div>
</>
) : (
<>
{mode !== "resend" && (
<nav className={s.authTabs} aria-label="账户操作">
<button
type="button"
aria-pressed={mode === "login"}
disabled={busy}
onClick={() => switchMode("login")}
>
登录
</button>
<button
type="button"
aria-pressed={mode === "register"}
disabled={busy}
onClick={() => switchMode("register")}
>
创建账户
</button>
</nav>
)}
<form onSubmit={submit}>
<fieldset className={s.formFieldset} disabled={busy}>
<div className={s.formField}>
<label htmlFor="account-email">邮箱地址</label>
<input
id="account-email"
className={s.input}
type="email"
name="email"
autoComplete="email"
placeholder="you@example.com"
required
maxLength={254}
value={email}
onChange={(e) => setEmail(e.target.value)}
/>
</div>
<div className={s.formField}>
<label htmlFor="account-password">密码</label>
<div className={s.passwordField}>
<input
id="account-password"
className={s.input}
type={showPassword ? "text" : "password"}
name="password"
autoComplete={
mode === "register"
? "new-password"
: "current-password"
}
placeholder={
mode === "register"
? "设置至少 12 个字符的密码"
: "输入你的密码"
}
minLength={12}
maxLength={256}
required
value={password}
onChange={(e) => setPassword(e.target.value)}
/>
<button
type="button"
aria-label={showPassword ? "隐藏密码" : "显示密码"}
onClick={() => setShowPassword((value) => !value)}
>
{showPassword ? <EyeOff size={16} /> : <Eye size={16} />}
</button>
</div>
{mode === "register" && (
<small className={s.fieldHint}>
建议使用包含字母、数字的长密码。
</small>
)}
</div>
<button className={s.primaryButton} type="submit">
{busy
? "正在处理…"
: mode === "login"
? "登录"
: mode === "register"
? "创建账户"
: "发送验证邮件"}
{!busy && <ArrowRight size={15} />}
</button>
</fieldset>
</form>
<div className={s.authSecondary}>
{mode === "resend" ? (
<button
type="button"
disabled={busy}
onClick={() => switchMode("login")}
>
返回登录
</button>
) : (
<button
type="button"
disabled={busy}
onClick={() => switchMode("resend")}
>
没有收到验证邮件?重新发送
</button>
)}
</div>
<p className={s.authFootnote}>
注册后需要先验证邮箱。公开文档始终可以直接阅读。
</p>
</>
)}
</section>
</div>
);
}
@@ -1,27 +1,126 @@
import { ZodError } from 'zod';
import type { NextApiRequest,NextApiResponse } from 'next';
import { currentAccount } from '@/lib/account';
import { trustedOrigin } from '@/lib/account-crypto';
import { documentInput,parseDocumentXml } from '@/lib/guidance-input';
import { discoverDocuments,publishDocument,resolveDocument,withdrawDocument } from '@/lib/guidance-store';
import { guidanceXml } from '@/content/guides/catalog';
export default async function handler(req:NextApiRequest,res:NextApiResponse){
res.setHeader('Cache-Control','no-store');const path=req.query.path||[];if(!Array.isArray(path)||path.length>1)return res.status(404).end();const id=path[0];
try{
if(req.method==='GET'){
if(!id)return res.json({documents:await discoverDocuments()});
const revision=req.query.revision;if(revision!==undefined&&(typeof revision!=='string'||! /^[1-9][0-9]{0,9}$/.test(revision)||Number(revision)>2147483647))return res.status(400).json({error:'版本无效'});
const doc=await resolveDocument(id,revision===undefined?undefined:Number(revision));if(!doc)return res.status(404).json({error:'文档或精确版本不存在'});
if(req.query.format==='xml'){res.setHeader('Content-Type','application/xml; charset=utf-8');return res.send(guidanceXml(doc));}return res.json({document:doc});}
if(!['POST','DELETE'].includes(req.method||'')){res.setHeader('Allow','GET, POST, DELETE');return res.status(405).end();}
const request=new Request(new URL(req.url||'/',process.env.ACCOUNT_PUBLIC_ORIGIN||'http://'+req.headers.host),{headers:new Headers(Object.entries(req.headers).filter(([,v])=>typeof v==='string') as [string,string][])});
if(!trustedOrigin(request))return res.status(403).json({error:'请求来源不受信任'});
const user=await currentAccount(request);if(!user)return res.status(401).json({error:'请先登录已验证邮箱账户'});
if(req.method==='DELETE')return id&&await withdrawDocument(user.id,id)?res.json({ok:true}):res.status(404).json({error:'无权删除或不存在'});
const input=typeof req.body==='string'?parseDocumentXml(req.body):documentInput.parse(req.body);
if(id==='preview'){const links=await Promise.all(input.links.map(async l=>({...l,resolved:!!await resolveDocument(l.target,l.revision)})));return res.json({document:input,xml:guidanceXml(input),links});}
if(id&&id!==input.id)return res.status(400).json({error:'文档 ID 不匹配'});
return res.status(201).json({document:await publishDocument(user.id,input)});
}catch(e){if(e instanceof ZodError)return res.status(400).json({error:'输入不符合协议,请检查以下字段',fields:e.issues.slice(0,12).map(i=>i.path.join('.')||'文档')});const message=e instanceof Error?e.message:'';if(message==='INVALID_ID')return res.status(400).json({error:'文档 ID 必须以 user-你的账户ID- 开头,请使用编辑器生成的前缀'});if(message==='FORBIDDEN')return res.status(403).json({error:'仅作者可编辑'});if(message==='CONFLICT'||(e as {code?:string}).code==='23505')return res.status(409).json({error:'版本冲突:请加载最新版本,已发布版本不可修改'});if(e instanceof Error&&(e.name==='ZodError'||/XML|实体|元素|属性|协议|链接/.test(message)))return res.status(400).json({error:'输入不符合协议'});return res.status(503).json({error:'文档服务暂不可用'});}
import { ZodError } from "zod";
import type { NextApiRequest, NextApiResponse } from "next";
import { currentAccount } from "@/lib/account";
import { trustedOrigin } from "@/lib/account-crypto";
import { documentInput, parseDocumentXml } from "@/lib/guidance-input";
import {
discoverDocuments,
publishDocument,
resolveDocument,
withdrawDocument,
} from "@/lib/guidance-store";
import { guidanceXml } from "@/content/guides/catalog";
export default async function handler(
req: NextApiRequest,
res: NextApiResponse,
) {
res.setHeader("Cache-Control", "no-store");
const path = req.query.path || [];
if (!Array.isArray(path) || path.length > 1) return res.status(404).end();
const id = path[0];
try {
if (req.method === "GET") {
if (!id) {
const author = req.query.author;
if (
author !== undefined &&
(typeof author !== "string" ||
!/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(
author,
))
)
return res.status(400).json({ error: "作者 ID 无效" });
return res.json({ documents: await discoverDocuments(author) });
}
const revision = req.query.revision;
if (
revision !== undefined &&
(typeof revision !== "string" ||
!/^[1-9][0-9]{0,9}$/.test(revision) ||
Number(revision) > 2147483647)
)
return res.status(400).json({ error: "版本无效" });
const doc = await resolveDocument(
id,
revision === undefined ? undefined : Number(revision),
);
if (!doc) return res.status(404).json({ error: "文档或精确版本不存在" });
if (req.query.format === "xml") {
res.setHeader("Content-Type", "application/xml; charset=utf-8");
return res.send(guidanceXml(doc));
}
return res.json({ document: doc });
}
if (!["POST", "DELETE"].includes(req.method || "")) {
res.setHeader("Allow", "GET, POST, DELETE");
return res.status(405).end();
}
const request = new Request(
new URL(
req.url || "/",
process.env.ACCOUNT_PUBLIC_ORIGIN || "http://" + req.headers.host,
),
{
headers: new Headers(
Object.entries(req.headers).filter(
([, v]) => typeof v === "string",
) as [string, string][],
),
},
);
if (!trustedOrigin(request))
return res.status(403).json({ error: "请求来源不受信任" });
const user = await currentAccount(request);
if (!user) return res.status(401).json({ error: "请先登录已验证邮箱账户" });
if (req.method === "DELETE")
return id && (await withdrawDocument(user.id, id))
? res.json({ ok: true })
: res.status(404).json({ error: "无权删除或不存在" });
const input =
typeof req.body === "string"
? parseDocumentXml(req.body)
: documentInput.parse(req.body);
if (id === "preview") {
const links = await Promise.all(
input.links.map(async (l) => ({
...l,
resolved: !!(await resolveDocument(l.target, l.revision)),
})),
);
return res.json({ document: input, xml: guidanceXml(input), links });
}
if (id && id !== input.id)
return res.status(400).json({ error: "文档 ID 不匹配" });
return res
.status(201)
.json({ document: await publishDocument(user.id, input) });
} catch (e) {
if (e instanceof ZodError)
return res
.status(400)
.json({
error: "输入不符合协议,请检查以下字段",
fields: e.issues.slice(0, 12).map((i) => i.path.join(".") || "文档"),
});
const message = e instanceof Error ? e.message : "";
if (message === "INVALID_ID")
return res
.status(400)
.json({
error: "文档 ID 必须以 user-你的账户ID- 开头,请使用编辑器生成的前缀",
});
if (message === "FORBIDDEN")
return res.status(403).json({ error: "仅作者可编辑" });
if (message === "CONFLICT" || (e as { code?: string }).code === "23505")
return res
.status(409)
.json({ error: "版本冲突:请加载最新版本,已发布版本不可修改" });
if (
e instanceof Error &&
(e.name === "ZodError" || /XML|实体|元素|属性|协议|链接/.test(message))
)
return res.status(400).json({ error: "输入不符合协议" });
return res.status(503).json({ error: "文档服务暂不可用" });
}
}
export const config={api:{bodyParser:{sizeLimit:'128kb'}}};
export const config = { api: { bodyParser: { sizeLimit: "128kb" } } };
@@ -1,6 +1,61 @@
import type { GetServerSideProps } from 'next';
import type { Guidance } from '@/content/guides/catalog';
import styles from '@/styles/documents.module.css';
type Props={canEdit:boolean;versions:number[];doc:Guidance;links:(Guidance['links'][number]&{resolved:boolean})[]};
export default function Read({doc,links,canEdit,versions}:Props){return <main className={styles.page}><nav><a href="/documents">用户文档</a> · <a href={canEdit?'/write?id='+doc.id:'/write'}>{canEdit?'编辑我的文档':'发布文档'}</a></nav><h1>{doc.title}</h1><p>{doc.kind} · {doc.id} · 固定版本 {doc.revision}</p><p>版本:{versions.map(v=><a key={v} href={'/documents/'+doc.id+'?revision='+v}> v{v} </a>)}</p><p>{doc.summary}</p><h2>适用条件</h2><p>{doc.applies}</p><p className={styles.body}>{doc.body}</p><ol>{doc.steps.map((s,i)=><li key={i}>{s}</li>)}</ol><h2>条件链接</h2>{links.map((l,i)=><article key={i}><p>条件:{l.when} · {l.relation}</p>{l.resolved?<a href={(l.target.startsWith('user-')?'/documents/':'/guide/')+l.target+'?revision='+l.revision}>{l.label} · v{l.revision}</a>:<p>{l.label}:精确版本缺失,请跳过</p>}</article>)}<h2>检查项</h2><ul>{doc.checks.map((s,i)=><li key={i}>{s}</li>)}</ul><a href={'/api/documents/'+doc.id+'?revision='+doc.revision+'&format=xml'}>读取规范 XML</a>{canEdit&&<p><button onClick={async()=>{if(!confirm('撤下后仍保留固定历史版本,确定撤下?'))return;const r=await fetch('/api/documents/'+doc.id,{method:'DELETE'});alert(r.ok?'已撤下,历史版本仍可访问':(await r.json()).error);}}>作者撤下文档</button></p>}</main>;}
export const getServerSideProps:GetServerSideProps<Props>=async({params,query,res,req})=>{res.setHeader('Cache-Control','no-store');const revision=query.revision;if(revision!==undefined&&(typeof revision!=='string'||! /^[1-9][0-9]{0,9}$/.test(revision)||Number(revision)>2147483647))return {notFound:true};const {resolveDocument}=await import('@/lib/guidance-store');const doc=await resolveDocument(String(params?.id),revision===undefined?undefined:Number(revision));if(!doc)return {notFound:true};const links=await Promise.all(doc.links.map(async l=>({...l,resolved:!!await resolveDocument(l.target,l.revision)})));const {db}=await import('@/lib/db');const {currentAccount}=await import('@/lib/account');const user=await currentAccount(new Request('http://internal',{headers:{cookie:req.headers.cookie||''}}));const owner=await db().query('SELECT owner_id FROM guidance_documents WHERE id=$1',[doc.id]);const rows=await db().query('SELECT revision FROM guidance_revisions WHERE document_id=$1 ORDER BY revision DESC',[doc.id]);return {props:{doc,links,canEdit:!!user&&owner.rows[0]?.owner_id===user.id,versions:rows.rows.map(r=>r.revision)}};};
import type { GetServerSideProps } from "next";
import GuidanceReader, { type ReaderProps } from "@/components/GuidanceReader";
export default function Read(props: ReaderProps) {
return <GuidanceReader {...props} />;
}
export const getServerSideProps: GetServerSideProps<ReaderProps> = async ({
params,
query,
res,
req,
}) => {
res.setHeader("Cache-Control", "no-store");
const revision = query.revision;
if (
revision !== undefined &&
(typeof revision !== "string" ||
!/^[1-9][0-9]{0,9}$/.test(revision) ||
Number(revision) > 2147483647)
)
return { notFound: true };
const { resolveDocument } = await import("@/lib/guidance-store");
const document = await resolveDocument(
String(params?.id),
revision === undefined ? undefined : Number(revision),
);
if (!document) return { notFound: true };
const links = await Promise.all(
document.links.map(async (link) => ({
...link,
resolved: !!(await resolveDocument(link.target, link.revision)),
})),
);
const { db } = await import("@/lib/db");
const { currentAccount } = await import("@/lib/account");
const user = await currentAccount(
new Request("http://internal", {
headers: { cookie: req.headers.cookie || "" },
}),
);
const owner = await db().query(
"SELECT owner_id,deleted_at FROM guidance_documents WHERE id=$1",
[document.id],
);
const rows = await db().query(
"SELECT revision,created_at FROM guidance_revisions WHERE document_id=$1 ORDER BY revision DESC",
[document.id],
);
return {
props: {
document,
source: "community",
links,
canEdit: !!user && owner.rows[0]?.owner_id === user.id,
withdrawn: !!owner.rows[0]?.deleted_at,
versions: rows.rows.map((r) => ({
revision: r.revision,
createdAt: new Date(r.created_at).toISOString(),
})),
},
};
};
@@ -1,3 +1,4 @@
import { useEffect,useState } from 'react';
import styles from '@/styles/documents.module.css';
export default function Documents(){const [docs,setDocs]=useState<{id:string;revision:number;title:string;summary:string;kind:string}[]>([]),[error,setError]=useState('');useEffect(()=>{fetch('/api/documents').then(async r=>{const b=await r.json();if(!r.ok)throw Error(b.error);setDocs(b.documents);}).catch(e=>setError(e.message));},[]);return <main className={styles.page}><nav><a href="/">首页</a> · <a href="/write">发布文档</a></nav><h1>用户发布的文档</h1><p>{error}</p>{docs.map(d=><article key={d.id}><h2><a href={'/documents/'+d.id+'?revision='+d.revision}>{d.title}</a></h2><p>{d.kind} · v{d.revision}</p><p>{d.summary}</p></article>)}</main>;}
import DocumentDirectory from "@/components/DocumentDirectory";
export default function Documents() {
return <DocumentDirectory communityOnly />;
}
+44 -9
View File
@@ -1,9 +1,44 @@
import type {GetServerSideProps} from 'next';
import Head from 'next/head';
import Link from 'next/link';
import {useState} from 'react';
import GuidanceShell from '@/components/GuidanceShell';
import {findGuide,guides,guidanceXml,type Guidance} from '@/content/guides/catalog';
import s from '@/styles/guidance.module.css';
export default function Guide({guide:g,backlinks}:{guide:Guidance;backlinks:{id:string;title:string}[]}){const[xml,setXml]=useState(false);return <GuidanceShell><Head><title>{g.title} · 织页</title></Head><main className={s.detail}><p className={s.meta}><Link href="/">文档</Link> / protocol-examples / {g.id}</p><span className={s.eyebrow}>{g.kind.toUpperCase()} · REVISION {g.revision}</span><h1>{g.title}</h1><p>{g.summary}</p><div className={s.tabs}><button aria-pressed={!xml} onClick={()=>setXml(false)}>阅读</button><button aria-pressed={xml} onClick={()=>setXml(true)}>XML 源文档</button><a href={`/api/guides/${g.id}?revision=${g.revision}&format=xml`}>单篇机器接口 ↗</a></div><div className={s.detailGrid}><article className={s.prose}>{xml?<pre>{guidanceXml(g)}</pre>:<><h2>何时使用</h2><p>{g.applies}</p><h2>指导正文</h2><p>{g.body}</p><h2>建议步骤</h2><ol>{g.steps.map(t=><li key={t}>{t}</li>)}</ol><h2>完成检查</h2><ul>{g.checks.map(t=><li key={t}>{t}</li>)}</ul><h2>继续探索</h2>{g.links.map(l=><Link className={s.related} key={l.target} href={`/guide/${l.target}?revision=${l.revision}`}><strong>{l.label} ↗</strong><span>当{l.when} · {l.relation} · r{l.revision}</span></Link>)}{!g.links.length&&<p>这篇文档可独立使用,没有建议继续读取的链接。</p>}</>}</article><aside className={s.note}><h3>采用这篇文档</h3><p>把单篇机器接口交给 Agent。仅当链接条件适用时,再读取关联文档。</p><p>读取链接不授予执行权限。背景和依据不作为操作指令。</p><h3>被这些文档引用</h3>{backlinks.map(b=><p key={b.id}><Link href={`/guide/${b.id}`}>{b.title} ↗</Link></p>)}{!backlinks.length&&<p>暂时没有反向链接。</p>}</aside></div></main></GuidanceShell>}
export const getServerSideProps:GetServerSideProps=async({params,query})=>{const r=query.revision;if(r!==undefined&&(typeof r!=='string'||!/^\d+$/.test(r)))return{notFound:true};const guide=findGuide(String(params?.id),r===undefined?undefined:Number(r));return guide?{props:{guide,backlinks:guides.filter(g=>g.links.some(l=>l.target===guide.id&&l.revision===guide.revision)).map(({id,title})=>({id,title}))}}:{notFound:true};};
import type { GetServerSideProps } from "next";
import GuidanceReader, { type ReaderProps } from "@/components/GuidanceReader";
import { findGuide, guides } from "@/content/guides/catalog";
export default function Guide(props: ReaderProps) {
return <GuidanceReader {...props} />;
}
export const getServerSideProps: GetServerSideProps<ReaderProps> = async ({
params,
query,
}) => {
const r = query.revision;
if (r !== undefined && (typeof r !== "string" || !/^\d+$/.test(r)))
return { notFound: true };
const document = findGuide(
String(params?.id),
r === undefined ? undefined : Number(r),
);
if (!document) return { notFound: true };
return {
props: {
document,
source: "example",
versions: [{ revision: document.revision }],
links: document.links.map((link) => ({
...link,
resolved: !!findGuide(link.target, link.revision),
})),
backlinks: guides
.filter((g) =>
g.links.some(
(link) =>
link.target === document.id &&
link.revision === document.revision,
),
)
.map(({ id, title, revision }) => ({
id,
title,
revision,
source: "example",
})),
},
};
};
+3 -74
View File
@@ -1,75 +1,4 @@
import Head from 'next/head';
import Link from 'next/link';
import {useRouter} from 'next/router';
import {useEffect,useState,type FormEvent} from 'react';
import GuidanceShell from '@/components/GuidanceShell';
import {guides} from '@/content/guides/catalog';
import s from '@/styles/guidance.module.css';
type PublishedDocument={id:string;revision:number;title:string;summary:string;kind:string};
const categories=[['all','全部文档'],['guide','操作指导'],['context','背景知识'],['evidence','事实依据']];
export default function Home(){
const router=useRouter();
const [published,setPublished]=useState<PublishedDocument[]>([]);
const [loadError,setLoadError]=useState('');
const [loading,setLoading]=useState(true);
const [q,setQ]=useState('');
const [kind,setKind]=useState('all');
useEffect(()=>{
let active=true;
fetch('/api/documents').then(async r=>{
const b=await r.json();if(!r.ok)throw Error(b.error);
if(active)setPublished(b.documents);
}).catch(e=>{if(active)setLoadError(e.message);}).finally(()=>{if(active)setLoading(false);});
return()=>{active=false;};
},[]);
useEffect(()=>{
if(!router.isReady)return;
setQ(typeof router.query.q==='string'?router.query.q:'');
setKind(typeof router.query.kind==='string'&&categories.some(([key])=>key===router.query.kind)?router.query.kind:'all');
},[router.isReady,router.query.q,router.query.kind]);
function rememberFilters(query:string,category:string){
const next:{q?:string;kind?:string}={};
if(query)next.q=query;if(category!=='all')next.kind=category;
void router.push({pathname:'/',query:next},undefined,{shallow:true,scroll:false});
}
function search(e:FormEvent){e.preventDefault();rememberFilters(q,kind);}
function chooseKind(value:string){setKind(value);rememberFilters(q,value);}
function clearFilters(){setQ('');setKind('all');rememberFilters('','all');}
const matches=(g:{title:string;summary:string;kind:string;tags?:string[]})=>(kind==='all'||g.kind===kind)&&`${g.title} ${g.summary} ${g.tags?.join(' ')||''}`.toLowerCase().includes(q.trim().toLowerCase());
const items=guides.filter(matches),userItems=published.filter(matches);
const total=items.length+userItems.length;
return <GuidanceShell>
<Head><title>织页 · 为 Agent 找到下一页</title></Head>
<section className={s.hero}>
<span className={s.eyebrow}>A WEB OF USEFUL KNOWLEDGE</span>
<h1>一个起点,<br/>连接下一种可能。</h1>
<p>每一篇文档,都能独立帮助你的 Agent。<br/>从当前问题出发,沿着有用的链接继续探索。</p>
<form className={s.search} role="search" onSubmit={search}>
<span aria-hidden="true">⌕</span><input aria-label="搜索文档" placeholder="搜索文档、任务或一种想法…" value={q} onChange={e=>setQ(e.target.value)}/><button type="submit">搜索</button>
</form>
<div className={s.topics}>{['代码审查','规划','验证'].map(t=><button key={t} onClick={()=>{setQ(t);rememberFilters(t,kind);}}>{t} ↗</button>)}</div>
</section>
<main className={s.layout}>
<aside className={s.sidebar}>
<h2>文档目录</h2>
{categories.map(([key,label])=><button key={key} aria-pressed={kind===key} onClick={()=>chooseKind(key)}>{label}<span>{[...guides,...published].filter(g=>key==='all'||g.kind===key).length}</span></button>)}
<p>一个文档就是一个入口。<br/>集合是组织方式,<br/>无需整套安装。</p>
</aside>
<section aria-label="文档搜索结果">
<div className={s.sectionTitle}><p role="status">{loading?'正在加载用户文档…':loadError?`协议样例 ${items.length} 篇;用户文档加载失败`:`找到 ${total} 篇文档`}</p>{(q||kind!=='all')&&<button type="button" onClick={clearFilters}>清除所有筛选</button>}</div>
{loadError&&<p role="alert">用户文档暂未加载:{loadError}。下方仍可阅读协议样例。</p>}
{!loading&&!loadError&&total===0&&<p>没有匹配文档,请尝试其他关键词或清除筛选。</p>}
<div className={s.sectionTitle}><h2>用户发布 <small>{userItems.length} 篇</small></h2><Link href="/write">发布一篇文档 ↗</Link></div>
<div className={s.list}>{userItems.map(g=><article className={s.row} key={g.id}><div className={s.icon}>↗</div><div><div className={s.meta}>{g.id} · {g.kind} · v{g.revision}</div><h3><Link href={`/documents/${g.id}?revision=${g.revision}`}>{g.title}</Link></h3><p>{g.summary}</p></div></article>)}</div>
{!loading&&!loadError&&!published.length&&<p>还没有用户文档。你可以发布第一篇,或先阅读下方样例。</p>}
<div className={s.sectionTitle}><h2>从这里开始 <small>{items.length} 篇</small></h2><span>协议样例 · v0.1</span></div>
<div className={s.list}>{items.map(g=><article className={s.row} key={g.id}><div className={s.icon}>{g.kind==='guide'?'↗':'≋'}</div><div><div className={s.meta}>织页 / protocol-examples · r{g.revision}</div><h3><Link href={`/guide/${g.id}`}>{g.title}</Link></h3><p>{g.summary}</p><div className={s.tags}>{g.tags.map(t=><span key={t}>{t}</span>)}<span>↗ {g.links.length} 个关联</span></div></div></article>)}</div>
</section>
<aside className={s.right}>
<div className={s.manifest}><span className={s.eyebrow}>DOCUMENTS, CONNECTED.</span><h2>知识不必<br/>打包带走。</h2><p>读一页,解决眼前的问题。<br/>需要更多时,再打开下一页。</p><Link href="/protocol">了解文档协议 ↗</Link></div>
<div className={s.note}><h3>为两种 Agent 而写</h3><p>Coding agent 的工作方法,Personal agent 的日常指导,都可以从一篇文档开始。</p><h3>这是一个早期原型</h3><p>已验证邮箱用户可以发布独立文档,更新会创建不可变版本。下方协议样例与真实用户文档分别展示。</p></div>
</aside>
</main>
</GuidanceShell>;
import DocumentDirectory from "@/components/DocumentDirectory";
export default function Home() {
return <DocumentDirectory />;
}
+202 -5
View File
@@ -1,5 +1,202 @@
import Head from 'next/head';
import GuidanceShell from '@/components/GuidanceShell';
import {guides,guidanceXml} from '@/content/guides/catalog';
import s from '@/styles/guidance.module.css';
export default function Protocol(){return <GuidanceShell><Head><title>Linked Guidance 0.1 · 织页</title></Head><main className={s.detail}><span className={s.eyebrow}>AN OPEN EXPERIMENT · 0.1</span><h1>让每一页,都能成为起点。</h1><p>Linked Guidance 协议草案 · 名称待定</p><article className={s.prose}><h2>从文档出发,按需连接</h2><p>每篇文档都有独立正文、适用条件和固定版本。集合只是整理方式,不要求整套安装。Agent 先阅读一篇,再判断链接是否有助于当前任务。</p><h2>从哪里开始</h2><p><a href="/agent/index.md">Agent 阅读入口 ↗</a> · <a href="/documents">真实用户文档 ↗</a> · <a href="/write">发布文档 ↗</a></p><h2>一个最小示例</h2><pre>{guidanceXml(guides[0])}</pre><h2>三种关系</h2><p>guide:可供采用的指导;context:背景知识;evidence:事实依据。背景和依据不会自动成为指令。</p><h2>读取约定</h2><ol><li>判断入口文档是否适合当前任务。</li><li>只跟随满足 when 条件且有帮助的链接。</li><li>按文档与版本去重;默认最多 8 篇、深度 3 层。</li><li>固定版本缺失不退回最新版;预算耗尽时报告不完整。</li></ol><h2>权限不沿链接传播</h2><p>文档不会改变用户授权或运行环境约束。0.1 仅引用本站文档 id,不自动请求任意外部 URL,不执行 XML 实体或脚本。</p><h2>协议状态</h2><p>这是待验证原型,并非现有 Agent 原生标准。当前提供单篇 XML 接口、已验证邮箱作者发布与固定版本历史。跨站发现与原生 Agent 适配仍待实现。</p><p>研究起点:<a href="https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f">Karpathy 的 LLM Wiki 原始提案 ↗</a>。XML 语法是本项目提出的设计。</p></article></main></GuidanceShell>}
import Link from "next/link";
import {
ArrowUpRight,
BookOpen,
Bot,
Braces,
GitBranch,
Link2,
ShieldCheck,
Target,
} from "lucide-react";
import GuidanceShell from "@/components/GuidanceShell";
import { CopyButton, KindBadge, PageHeading } from "@/components/GuidanceUI";
import { guides, guidanceXml } from "@/content/guides/catalog";
import s from "@/styles/guidance.module.css";
const sections = [
["idea", "独立文档"],
["start", "开始读取"],
["syntax", "文档语法"],
["relations", "三种关系"],
["reading", "读取约定"],
["permissions", "权限边界"],
["status", "协议状态"],
];
export default function Protocol() {
const xml = guidanceXml(guides[0]);
return (
<GuidanceShell title="文档协议">
<PageHeading
title="从一篇文档,连接下一种可能。"
description="Linked Guidance 0.1 · 为独立指导文档设计的实验协议"
eyebrow="DOCUMENTATION"
>
<a
href="/agent/index.md"
target="_blank"
rel="noreferrer"
className={s.secondaryButton}
>
<Bot size={15} />
Agent 读取入口
<ArrowUpRight size={13} />
</a>
</PageHeading>
<div className={s.protocolLayout}>
<article className={`${s.panel} ${s.protocolArticle}`}>
<section id="idea" className={s.proseSection}>
<h2>
<BookOpen size={17} />
文档是起点,集合只是组织方式
</h2>
<p>
每篇文档都有完整正文、适用条件和固定版本。Coding agent 与 personal
agent
都可以从一篇文档开始;需要更多帮助时,再判断关联链接是否适合当前任务。无需把一整组文档一起安装或加载。
</p>
</section>
<section id="start" className={s.proseSection}>
<h2>
<Target size={17} />
从哪里开始
</h2>
<p>
先通过目录发现摘要,再读取一篇文档的固定版本。人的阅读界面与 Agent
的 XML 接口引用同一份内容。
</p>
<div className={s.buttonRow} style={{ marginTop: 16 }}>
<Link className={s.secondaryButton} href="/">
探索文档
<ArrowUpRight size={13} />
</Link>
<Link className={s.secondaryButton} href="/documents">
社区文档
<ArrowUpRight size={13} />
</Link>
<Link className={s.secondaryButton} href="/write">
发布文档
<ArrowUpRight size={13} />
</Link>
</div>
<code className={s.machineAddress}>/agent/index.md</code>
<CopyButton
label="复制 Agent 入口"
value={() => window.location.origin + "/agent/index.md"}
/>
</section>
<section id="syntax" className={s.proseSection}>
<h2>
<Braces size={17} />
一份可独立读取的文档
</h2>
<p>
XML 描述文档本身,以及何时可能需要其他文档。固定 revision
保留精确引用;未知版本与缺失目标需要明确处理。
</p>
<pre className={s.codeBlock}>{xml}</pre>
<CopyButton label="复制示例 XML" value={xml} />
</section>
<section id="relations" className={s.proseSection}>
<h2>
<Link2 size={17} />
把关系写清楚
</h2>
<p>
链接是有条件的阅读建议,不是强制依赖。when
用自然语言说明何时可能需要目标文档。
</p>
<div className={s.relationGrid}>
<div>
<KindBadge kind="guide" />
<p>可供采用的工作方法。仍需先判断是否适用,并遵守用户授权。</p>
</div>
<div>
<KindBadge kind="context" />
<p>用于理解任务的背景知识,不会自动成为操作指令。</p>
</div>
<div>
<KindBadge kind="evidence" />
<p>为判断提供事实与依据。引用时需要保留实际来源和版本。</p>
</div>
</div>
</section>
<section id="reading" className={s.proseSection}>
<h2>
<GitBranch size={17} />
按需读取,固定版本
</h2>
<ol>
<li>先看入口文档的适用条件,再读正文与步骤。</li>
<li>只跟随 when 条件成立、且能补充当前任务所需知识的链接。</li>
<li>
以文档 ID 与版本去重,默认读取预算为 8 篇、最大深度 3 层。
</li>
<li>
固定版本缺失时不静默回退最新版;遇到循环或预算耗尽时停止扩展,并说明未完成的读取。
</li>
</ol>
</section>
<section id="permissions" className={s.proseSection}>
<h2>
<ShieldCheck size={17} />
权限不会沿链接传播
</h2>
<p>
读取文档不等于接受其中所有指令。用户任务和运行环境规则始终优先,文档不能要求获取秘密、扩大权限或改变目标。0.1
只引用本站逻辑 ID,不自动请求任意外部 URL,也不执行 XML
实体或脚本。
</p>
</section>
<section id="status" className={s.proseSection}>
<h2>协议状态</h2>
<p>
Linked Guidance 是本项目提出的实验协议,并非现有 Agent
已原生支持的标准。当前支持独立 XML/JSON
读取、已验证邮箱作者发布,以及不可变版本;跨站发现与原生 Agent
适配仍待实现。
</p>
<div className={s.protocolCallout}>
<p>
研究起点:
<a
className={s.textLink}
href="https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f"
target="_blank"
rel="noreferrer"
>
Karpathy 的 LLM Wiki 提案
<ArrowUpRight size={11} />
</a>
。本项目在持久交叉引用的基础上,提出独立指导单元、条件链接、关系类型和版本约定。
</p>
</div>
</section>
</article>
<aside className={s.readingSidebar}>
<section className={s.sideCard}>
<h3>本页目录</h3>
<nav className={s.toc} aria-label="协议目录">
{sections.map(([id, label]) => (
<a href={"#" + id} key={id}>
{label}
</a>
))}
</nav>
</section>
<section className={s.sideCard}>
<h3>开始编写你的第一篇</h3>
<p>从适用条件与清晰正文开始。关联链接可以在需要时再补充。</p>
<Link
className={s.textLink}
href="/write"
style={{ marginTop: 14 }}
>
创建文档
<ArrowUpRight size={12} />
</Link>
</section>
</aside>
</div>
</GuidanceShell>
);
}
+728 -13
View File
@@ -1,14 +1,729 @@
import { useEffect,useState } from 'react';
import type { Guidance } from '@/content/guides/catalog';
import styles from '@/styles/documents.module.css';
const blank:Guidance={id:'user-',revision:1,kind:'guide',title:'',summary:'',applies:'',body:'',steps:[],checks:[],links:[],tags:[]};
export default function Write(){
const [busy,setBusy]=useState(false),[published,setPublished]=useState<{id:string;revision:number}|null>(null);
const [doc,setDoc]=useState(blank),[xml,setXml]=useState(''),[mode,setMode]=useState(false),[message,setMessage]=useState(''),[preview,setPreview]=useState<{document:Guidance;xml:string;links:{label:string;when:string;resolved:boolean}[]}|null>(null);
useEffect(()=>{setPreview(null);},[doc,xml,mode]);
useEffect(()=>{fetch('/api/account/session').then(r=>r.json()).then(b=>{if(b.user){const id=new URLSearchParams(window.location.search).get('id');if(id)fetch('/api/documents/'+encodeURIComponent(id)).then(responseBody).then(b=>setDoc({...b.document,revision:b.document.revision+1})).catch(e=>setMessage(e.message));else setDoc(d=>({...d,id:'user-'+b.user.id+'-'}));}else setMessage('请先登录并验证邮箱,再发布文档。');}).catch(()=>setMessage('账户服务暂不可用,请稍后重试。'));},[]);
async function responseBody(r:Response){const b=await r.json().catch(()=>({error:'服务返回异常,请稍后重试'}));if(!r.ok)throw Error((b.error||'请求失败')+(b.fields?.length?':'+b.fields.join('、'):''));return b;}
async function load(){setBusy(true);setPreview(null);try{const b=await responseBody(await fetch('/api/documents/'+encodeURIComponent(doc.id)));setDoc({...b.document,revision:b.document.revision+1});setMessage('已加载,保存将创建新版本');}catch(e){setMessage(e instanceof Error?e.message:'加载失败');}finally{setBusy(false);}}
async function submit(action:string){setBusy(true);setMessage('处理中…');setPreview(null);setPublished(null);try{const b=await responseBody(await fetch('/api/documents'+(action==='preview'?'/preview':''),{method:'POST',headers:{'Content-Type':mode?'application/xml':'application/json'},body:mode?xml:JSON.stringify(doc)}));if(action==='preview'){setPreview(b);setMessage('预览成功,尚未发布');}else{setDoc({...b.document,revision:b.document.revision+1});setPublished({id:b.document.id,revision:b.document.revision});if(mode)setXml(xml.replace(/revision="[1-9][0-9]*"/,`revision="${b.document.revision+1}"`));setMessage('已发布版本 '+b.document.revision);}}catch(e){setMessage(e instanceof Error?e.message:'请求失败,请稍后重试');}finally{setBusy(false);}}
return <main className={styles.page}><nav><a href="/">首页</a> · <a href="/documents">用户文档</a> · <a href="/account">邮箱账户</a></nav><h1>发布独立文档</h1><p>需要已验证邮箱。每次发布创建不可变版本;只有原作者可以更新或撤下。</p><fieldset disabled={busy}><label><input type="checkbox" checked={mode} onChange={e=>{setMode(e.target.checked);setPreview(null);}}/> 使用协议 XML(zh-CN)</label>{mode?<label>XML 输入<textarea rows={22} value={xml} onChange={e=>{setXml(e.target.value);setPreview(null);}}/></label>:<><label>文档 ID(保留账户前缀,在末尾填写短名)<input value={doc.id} onChange={e=>setDoc({...doc,id:e.target.value})}/></label><button disabled={busy} onClick={load}>加载最新版本以编辑</button><label>待发布版本<input type="number" min={1} value={doc.revision} onChange={e=>setDoc({...doc,revision:Number(e.target.value)})}/></label><label>种类<select value={doc.kind} onChange={e=>setDoc({...doc,kind:e.target.value as Guidance['kind']})}><option>guide</option><option>context</option><option>evidence</option></select></label>{(['title','summary','applies','body'] as const).map(k=><label key={k}>{{title:'标题',summary:'摘要',applies:'适用条件',body:'正文'}[k]}<textarea value={doc[k]} onChange={e=>{setDoc({...doc,[k]:e.target.value});setPreview(null);}}/></label>)}{(['steps','checks'] as const).map(k=><label key={k}>{k==='steps'?'步骤':'检查项'}(每行一项)<textarea value={doc[k].join('\n')} onChange={e=>setDoc({...doc,[k]:e.target.value.split('\n').filter(Boolean)})}/></label>)}<h2>条件链接</h2>{doc.links.map((l,i)=><fieldset key={i}>{(['target','revision','relation','when','label'] as const).map(k=><label key={k}>{k}<input value={l[k]} onChange={e=>setDoc({...doc,links:doc.links.map((v,j)=>j===i?{...v,[k]:k==='revision'?Number(e.target.value):e.target.value}:v)})}/></label>)}<button onClick={()=>setDoc({...doc,links:doc.links.filter((_,j)=>j!==i)})}>移除链接</button></fieldset>)}<button onClick={()=>setDoc({...doc,links:[...doc.links,{target:'',revision:1,relation:'context',when:'',label:''}]})}>添加精确版本链接</button></>}<p><button disabled={busy} onClick={()=>submit('preview')}>校验并预览</button> <button disabled={busy} onClick={()=>submit('publish')}>发布新版本</button></p></fieldset><p role="status">{message}</p>{published&&<p><a href={'/documents/'+published.id+'?revision='+published.revision}>打开已发布文档 v{published.revision} ↗</a></p>}{preview&&<article><h2>{preview.document.title}</h2><p>{preview.document.summary}</p><p>适用:{preview.document.applies}</p><p className={styles.body}>{preview.document.body}</p>{preview.document.steps.map((s,i)=><p key={i}>{i+1}. {s}</p>)}{preview.links.map((l,i)=><p key={i}>{l.label} · 条件:{l.when} · {l.resolved?'精确版本可用':'目标缺失,读取时需跳过'}</p>)}<pre>{preview.xml}</pre></article>}</main>;
import Link from "next/link";
import { useRouter } from "next/router";
import { useEffect, useRef, useState } from "react";
import {
ArrowUpRight,
Braces,
CheckCircle2,
FileText,
Globe2,
Link2,
ListChecks,
Plus,
ShieldCheck,
Trash2,
} from "lucide-react";
import GuidanceShell, { useGuidanceAccount } from "@/components/GuidanceShell";
import {
EmptyState,
KindBadge,
Notice,
PageHeading,
kindNames,
} from "@/components/GuidanceUI";
import { guidanceXml, type Guidance } from "@/content/guides/catalog";
import s from "@/styles/guidance.module.css";
const blank: Guidance = {
id: "",
revision: 1,
kind: "guide",
title: "",
summary: "",
applies: "",
body: "",
steps: [],
checks: [],
links: [],
tags: [],
};
type Preview = {
document: Guidance;
xml: string;
links: { label: string; when: string; resolved: boolean }[];
};
function fieldName(path: string) {
const labels: Record<string, string> = {
id: "文档短名",
revision: "版本",
kind: "文档类型",
title: "标题",
summary: "一句话摘要",
applies: "适用条件",
body: "正文",
steps: "建议步骤",
checks: "完成检查",
tags: "标签",
target: "目标文档 ID",
relation: "关系类型",
when: "读取条件",
label: "链接标题",
};
const [group, index, field] = path.split(".");
if (group === "links")
return (
"关联文档" +
(index === undefined ? "" : " " + (Number(index) + 1)) +
(field ? " · " + (labels[field] || "内容") : "")
);
return (
(labels[group] || "文档内容") +
(index !== undefined ? " " + (Number(index) + 1) : "")
);
}
async function responseBody(response: Response) {
const body = await response
.json()
.catch(() => ({ error: "服务返回异常,请稍后重试" }));
if (!response.ok)
throw Error(
(body.error || "请求失败") +
(body.fields?.length
? ":" + body.fields.map(fieldName).join("、")
: ""),
);
return body;
}
export default function Write() {
return (
<GuidanceShell title="发布文档">
<Editor />
</GuidanceShell>
);
}
function Editor() {
const account = useGuidanceAccount(),
router = useRouter(),
dialog = useRef<HTMLDialogElement>(null);
const [doc, setDoc] = useState<Guidance>(blank),
[xml, setXml] = useState(""),
[mode, setMode] = useState<"form" | "xml">("form"),
[busy, setBusy] = useState(false),
[loading, setLoading] = useState(false),
[error, setError] = useState(""),
[preview, setPreview] = useState<Preview | null>(null),
[published, setPublished] = useState<{
id: string;
revision: number;
} | null>(null),
[dirty, setDirty] = useState(true);
const prefix = account.user ? "user-" + account.user.id + "-" : "",
editId = typeof router.query.id === "string" ? router.query.id : "";
useEffect(() => {
if (!router.isReady || !account.user) return;
let active = true;
setError("");
setPublished(null);
setPreview(null);
setMode("form");
setDirty(true);
if (!editId) {
setDoc({
...blank,
id:
"user-" +
account.user.id +
"-document-" +
Math.random().toString(16).slice(2, 8),
});
setLoading(false);
return;
}
if (!editId.startsWith("user-" + account.user.id + "-")) {
setError("只能编辑你自己发布的文档。");
setDoc(blank);
return;
}
setLoading(true);
fetch("/api/documents/" + encodeURIComponent(editId))
.then(responseBody)
.then((body) => {
if (active)
setDoc({ ...body.document, revision: body.document.revision + 1 });
})
.catch((e) => {
if (active) {
setError(e.message);
setDoc(blank);
}
})
.finally(() => {
if (active) setLoading(false);
});
return () => {
active = false;
};
}, [account.user?.id, editId, router.isReady]);
function change<K extends keyof Guidance>(key: K, value: Guidance[K]) {
setDoc((current) => ({ ...current, [key]: value }));
setPreview(null);
setDirty(true);
setPublished(null);
}
async function request(action: "preview" | "publish" | "convert") {
setBusy(true);
setError("");
setPreview(null);
try {
const body = await responseBody(
await fetch(
"/api/documents" + (action === "publish" ? "" : "/preview"),
{
method: "POST",
headers: {
"Content-Type":
mode === "xml" ? "application/xml" : "application/json",
},
body: mode === "xml" ? xml : JSON.stringify(normalized()),
},
),
);
if (action === "convert") {
setDoc(body.document);
setMode("form");
} else if (action === "preview") {
setPreview(body);
dialog.current?.showModal();
} else {
setDoc({ ...body.document, revision: body.document.revision + 1 });
setXml(
guidanceXml({
...body.document,
revision: body.document.revision + 1,
}),
);
setPublished({
id: body.document.id,
revision: body.document.revision,
});
setDirty(false);
}
} catch (e) {
setError(e instanceof Error ? e.message : "请求失败,请稍后重试");
} finally {
setBusy(false);
}
}
function normalized() {
return {
...doc,
steps: doc.steps.filter((step) => step.trim()),
checks: doc.checks.filter((check) => check.trim()),
tags: doc.tags.filter((tag) => tag.trim()),
};
}
function selectXml() {
setXml(guidanceXml(normalized()));
setMode("xml");
setPreview(null);
}
const authorized = account.user?.verified_at;
return (
<>
<PageHeading
title="发布独立文档"
description="一篇文档,一项清晰的指导。按需关联,让 Agent 自由选择。"
eyebrow={editId ? "UPDATE DOCUMENT" : "NEW DOCUMENT"}
/>
{account.loading ? (
<div className={s.accountLoading}>正在读取账户…</div>
) : !authorized ? (
<section className={`${s.panel} ${s.publishGate}`}>
<EmptyState
title={account.user ? "验证邮箱后继续" : "登录后开始编写"}
description={
account.error ||
"公开阅读无需登录。发布和维护文档,需要一个已验证的邮箱账户。"
}
>
<Link className={s.primaryButton} href="/account?next=%2Fwrite">
<ShieldCheck size={15} />
{account.user ? "前往验证邮箱" : "登录 / 创建账户"}
</Link>
</EmptyState>
</section>
) : (
<>
{error && <Notice tone="error">{error}</Notice>}
{published && (
<Notice tone="success">
版本 v{published.revision} 已公开发布。
<div className={s.successActions}>
<Link
href={
"/documents/" +
published.id +
"?revision=" +
published.revision
}
>
查看已发布版本
<ArrowUpRight size={12} />
</Link>
<Link href="/documents?scope=mine">查看我的文档</Link>
</div>
</Notice>
)}
{loading ? (
<div className={s.accountLoading}>正在加载最新版本…</div>
) : (
doc.id && (
<fieldset className={s.formFieldset} disabled={busy}>
<div className={s.editorTabs} aria-label="编辑方式">
<button
type="button"
aria-pressed={mode === "form"}
onClick={() => {
if (mode === "xml") void request("convert");
}}
>
可视化编辑
</button>
<button
type="button"
aria-pressed={mode === "xml"}
onClick={() => {
if (mode === "form") selectXml();
}}
>
协议 XML
</button>
</div>
<div className={s.formGrid}>
<div className={s.formSections}>
{mode === "xml" ? (
<section className={`${s.panel} ${s.formPanel}`}>
<h2 className={s.formSectionTitle}>
<Braces size={17} />
协议源文档
</h2>
<p className={s.formDescription}>
可直接粘贴完整
XML。切回可视化编辑时,会先校验并解析当前内容;校验失败时保留输入。
</p>
<label className={s.formField}>
<span className={s.fieldLabel}>XML 输入</span>
<textarea
className={`${s.textarea} ${s.xmlInput}`}
spellCheck={false}
value={xml}
onChange={(e) => {
setXml(e.target.value);
setDirty(true);
setPreview(null);
setPublished(null);
}}
/>
</label>
</section>
) : (
<>
<section className={`${s.panel} ${s.formPanel}`}>
<h2 className={s.formSectionTitle}>
<FileText size={17} />
基本信息
</h2>
<p className={s.formDescription}>
帮助读者和 Agent 判断,这篇文档是否适合当前任务。
</p>
<div className={s.fieldColumns}>
<label className={s.formField}>
<span className={s.fieldLabel}>文档短名</span>
<input
className={s.input}
aria-label="文档短名"
maxLength={37}
pattern="[a-z0-9-]+"
value={doc.id.slice(prefix.length)}
disabled={!!editId || doc.revision > 1}
onChange={(e) =>
change("id", prefix + e.target.value)
}
/>
<small className={s.fieldHint}>
小写字母、数字和连字符。发布后不可修改。
</small>
</label>
<label className={s.formField}>
<span className={s.fieldLabel}>文档类型</span>
<select
className={s.select}
value={doc.kind}
onChange={(e) =>
change(
"kind",
e.target.value as Guidance["kind"],
)
}
>
{Object.entries(kindNames).map(
([id, label]) => (
<option value={id} key={id}>
{label}
</option>
),
)}
</select>
</label>
</div>
{(["title", "summary", "applies"] as const).map(
(key) => (
<label className={s.formField} key={key}>
<span className={s.fieldLabel}>
{
{
title: "标题",
summary: "一句话摘要",
applies: "适用条件",
}[key]
}
<span className={s.required}>*</span>
</span>
{key === "title" ? (
<input
className={s.input}
value={doc[key]}
placeholder="例如:审查一次代码改动"
onChange={(e) =>
change(key, e.target.value)
}
/>
) : (
<textarea
className={s.textarea}
rows={2}
value={doc[key]}
placeholder={
key === "summary"
? "这篇文档可以帮助完成什么?"
: "什么情况下应该阅读?哪些情况不适用?"
}
onChange={(e) =>
change(key, e.target.value)
}
/>
)}
</label>
),
)}
<label className={s.formField}>
<span className={s.fieldLabel}>标签</span>
<input
className={s.input}
value={doc.tags.join(", ")}
placeholder="代码审查, 开发协作"
onChange={(e) =>
change(
"tags",
e.target.value
.split(/[,,]/)
.map((tag) => tag.trim()),
)
}
/>
<small className={s.fieldHint}>
使用逗号分隔。
</small>
</label>
</section>
<section className={`${s.panel} ${s.formPanel}`}>
<h2 className={s.formSectionTitle}>
<ListChecks size={17} />
指导内容
</h2>
<p className={s.formDescription}>
正文应当完整、可独立理解。步骤和检查项可以留空。
</p>
<label className={s.formField}>
<span className={s.fieldLabel}>
正文<span className={s.required}>*</span>
</span>
<textarea
className={`${s.textarea} ${s.bodyInput}`}
value={doc.body}
placeholder="写下清晰、具体的指导…"
onChange={(e) => change("body", e.target.value)}
/>
</label>
{(["steps", "checks"] as const).map((key) => (
<label className={s.formField} key={key}>
<span className={s.fieldLabel}>
{key === "steps" ? "建议步骤" : "完成检查"}
</span>
<textarea
className={s.textarea}
aria-label={
key === "steps" ? "建议步骤" : "完成检查"
}
rows={3}
value={doc[key].join("\n")}
onChange={(e) =>
change(key, e.target.value.split("\n"))
}
/>
<small className={s.fieldHint}>
每行一项,空行会在提交时忽略。
</small>
</label>
))}
</section>
<section className={`${s.panel} ${s.formPanel}`}>
<h2 className={s.formSectionTitle}>
<Link2 size={17} />
条件链接
<span className={s.neutralBadge}>
{doc.links.length}
</span>
</h2>
<p className={s.formDescription}>
仅当条件适用时,才建议读取关联文档。请指定固定版本;无需链接也可以独立发布。
</p>
{!doc.links.length && (
<div className={s.linkEmpty}>
还没有关联文档。你可以先完成正文,再为需要的场景补充链接。
</div>
)}
{doc.links.map((link, index) => (
<div className={s.linkEditor} key={index}>
<div className={s.linkEditorHeader}>
关联文档 {index + 1}
<button
type="button"
className={s.quietButton}
aria-label={"移除关联文档 " + (index + 1)}
onClick={() =>
change(
"links",
doc.links.filter((_, i) => i !== index),
)
}
>
<Trash2 size={13} />
移除
</button>
</div>
<div className={s.fieldColumns}>
{(
[
"target",
"revision",
"relation",
"label",
"when",
] as const
).map((key) => (
<label className={s.formField} key={key}>
<span className={s.fieldLabel}>
{
{
target: "目标文档 ID",
revision: "固定版本",
relation: "关系类型",
label: "链接标题",
when: "什么情况下读取",
}[key]
}
</span>
{key === "relation" ? (
<select
className={s.select}
value={link.relation}
onChange={(e) =>
change(
"links",
doc.links.map((item, i) =>
i === index
? {
...item,
relation: e.target
.value as Guidance["kind"],
}
: item,
),
)
}
>
{Object.entries(kindNames).map(
([id, label]) => (
<option value={id} key={id}>
{label}
</option>
),
)}
</select>
) : (
<input
className={s.input}
type={
key === "revision" ? "number" : "text"
}
min={key === "revision" ? 1 : undefined}
value={link[key]}
onChange={(e) =>
change(
"links",
doc.links.map((item, i) =>
i === index
? {
...item,
[key]:
key === "revision"
? Number(e.target.value)
: e.target.value,
}
: item,
),
)
}
/>
)}
</label>
))}
</div>
</div>
))}
<button
type="button"
className={s.secondaryButton}
onClick={() =>
change("links", [
...doc.links,
{
target: "",
revision: 1,
relation: "context",
when: "",
label: "",
},
])
}
>
<Plus size={14} />
添加条件链接
</button>
</section>
</>
)}
</div>
<aside className={s.publishSidebar}>
<section className={s.sideCard}>
<h3>
<Globe2 size={15} />
发布设置
</h3>
<div className={s.publishMeta}>
公开文档 · 待发布版本 v{doc.revision}
</div>
<KindBadge kind={doc.kind} />
<ul className={s.publishChecklist}>
<li className={s.completed}>
<CheckCircle2 size={14} />
邮箱已验证
</li>
<li>
<CheckCircle2 size={14} />
发布后任何人均可读取
</li>
<li>
<CheckCircle2 size={14} />
每次发布创建不可变版本
</li>
</ul>
<p>内容暂存在当前页面,请在离开前发布或自行保存 XML。</p>
<div className={s.publishButtons}>
<button
type="button"
className={s.secondaryButton}
onClick={() => void request("preview")}
>
校验并预览
</button>
<button
type="button"
className={s.primaryButton}
disabled={!dirty}
onClick={() => void request("publish")}
>
{busy
? "正在处理…"
: doc.revision === 1
? "发布文档"
: "发布新版本"}
</button>
</div>
</section>
<section className={s.sideCard}>
<h3>独立使用,按需连接</h3>
<p>
关系类型和适用条件帮助 Agent
选择下一篇文档。链接不会继承账户权限,也不要求整组加载。
</p>
<Link className={s.textLink} href="/protocol">
阅读协议说明
<ArrowUpRight size={12} />
</Link>
</section>
</aside>
</div>
</fieldset>
)
)}
</>
)}
<dialog
className={`${s.modal} ${s.largeModal}`}
ref={dialog}
aria-labelledby="preview-title"
>
<div className={s.modalBody}>
<h2 id="preview-title">发布预览</h2>
<p>校验已通过,内容尚未发布。请确认正文和关联条件。</p>
</div>
{preview && (
<div className={s.previewBody}>
<KindBadge kind={preview.document.kind} />
<h2 className={s.previewTitle}>{preview.document.title}</h2>
<p className={s.formDescription}>{preview.document.summary}</p>
<div className={s.appliesCard}>
<p>{preview.document.applies}</p>
</div>
<div className={s.proseBody}>{preview.document.body}</div>
{preview.document.steps.length > 0 && (
<ol className={s.stepList}>
{preview.document.steps.map((step, i) => (
<li key={i}>{step}</li>
))}
</ol>
)}
{preview.document.checks.length > 0 && (
<ul className={s.checkList}>
{preview.document.checks.map((check, i) => (
<li key={i}>{check}</li>
))}
</ul>
)}
{preview.links.map((link, i) => (
<div className={s.relationCard} key={i}>
<div>
<strong>{link.label}</strong>
<p>当{link.when}</p>
<small>
{link.resolved ? "固定版本可用" : "目标缺失,读取时需跳过"}
</small>
</div>
</div>
))}
</div>
)}
<div className={s.modalActions}>
<button
type="button"
className={s.secondaryButton}
onClick={() => dialog.current?.close()}
>
返回编辑
</button>
</div>
</dialog>
</>
);
}