From 5113af2a678341b623d42a6ddadaffa799326202 Mon Sep 17 00:00:00 2001 From: RealZST Date: Thu, 19 Nov 2026 15:09:43 +0800 Subject: [PATCH] feat(website): add llms.txt and a favicon.ico /llms.txt is built from the English docs, in the sidebar's groups and order, with each page's own title and description. The sidebar definition moves to its own module so the config and llms.txt share it. /favicon.ico (16, 32 and 48 px) answers clients that ask for it by default, and favicon.png goes from 32 to 96 px. Co-Authored-By: Claude Fable 5.2 --- website/astro.config.mjs | 21 +++------------------ website/public/favicon.ico | Bin 0 -> 15086 bytes website/public/favicon.png | Bin 1253 -> 5565 bytes website/src/data/docs-sidebar.ts | 20 ++++++++++++++++++++ website/src/pages/llms.txt.ts | 29 +++++++++++++++++++++++++++++ 5 files changed, 52 insertions(+), 18 deletions(-) create mode 100644 website/public/favicon.ico create mode 100644 website/src/data/docs-sidebar.ts create mode 100644 website/src/pages/llms.txt.ts diff --git a/website/astro.config.mjs b/website/astro.config.mjs index 71f49e92..92929fd6 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -6,7 +6,7 @@ import { pluginTerminal } from "./src/lib/ec-terminal.mjs"; import rehypeExternalLinks from "./src/lib/rehype-external-links.mjs"; import rehypeTableRegions from "./src/lib/rehype-table-regions.mjs"; import { en } from "./src/data/copy/en.ts"; -import { RELEASES_URL } from "./src/data/agents.ts"; +import { DOCS_SIDEBAR } from "./src/data/docs-sidebar.ts"; const SITE = "https://harness-kit.dev"; // The landing's English share image (public/og.png, scripts/og.mjs); share tags want an absolute URL. @@ -93,23 +93,8 @@ export default defineConfig({ { tag: "meta", attrs: { property: "og:image:alt", content: `HarnessKit · ${en.hero.title}` } }, { tag: "meta", attrs: { name: "twitter:image", content: SHARE_IMAGE } }, ], - // Groups start closed; Starlight opens the one holding the current page. - // Each label with its Chinese, as the App's zh UI and the landing name them; the pages under each come from - // their own titles. - // Getting started stays open: it is the group a first visit needs. Troubleshooting and the FAQ sit before - // Contributing, in the order a reader with a problem looks. - sidebar: [ - { label: "Overview", translations: { "zh-CN": "概览" }, slug: "docs" }, - { label: "Getting started", translations: { "zh-CN": "快速开始" }, collapsed: false, autogenerate: { directory: "docs/getting-started" } }, - { label: "Guides", translations: { "zh-CN": "使用指南" }, collapsed: true, autogenerate: { directory: "docs/guides" } }, - { label: "How it works", translations: { "zh-CN": "工作原理" }, collapsed: true, autogenerate: { directory: "docs/how-it-works" } }, - { label: "Reference", translations: { "zh-CN": "参考" }, collapsed: true, autogenerate: { directory: "docs/reference" } }, - { label: "Troubleshooting", translations: { "zh-CN": "常见问题排查" }, slug: "docs/troubleshooting" }, - { label: "FAQ", translations: { "zh-CN": "常见问题" }, slug: "docs/faq" }, - { label: "Contributing", translations: { "zh-CN": "参与贡献" }, collapsed: true, autogenerate: { directory: "docs/contributing" } }, - // The landing footer's Changelog link, so release notes are one click from the docs too. - { label: "Release notes ↗", translations: { "zh-CN": "更新日志 ↗" }, link: RELEASES_URL, attrs: { target: "_blank", rel: "noopener" } }, - ], + // In its own module, which /llms.txt also reads (src/pages/llms.txt.ts). + sidebar: DOCS_SIDEBAR, social: [{ icon: "github", label: "GitHub", href: "https://github.com/RealZST/HarnessKit" }], }), ], diff --git a/website/public/favicon.ico b/website/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..d8ef2c26f7f5b9f89f0780d9c448197e9ea3cb7d GIT binary patch literal 15086 zcmeI239wexk$``Lh(;4|Ok6Ta#2urF3`x*R8BJ2ij)HNI8WW8&aR7w~W~mX38WzEn zvKTNZh!jOY)L~H(cec$+BPk()H|L^|y{qF&fM`fnUQ`P@D_uTH& zefo6w>3hzfNSu&pm1x&4p>_L2{}U65&WS{#ef!{fmiAB8zK$Kk=Zg}Fu3t|iIw+35 zQi`Bot3*Qa&Nwvyd)6NjacC83dtYO98g6A}rQ>z3tE(H3OeP2FSOXNOtsUv>44>-i zYNzqBo={qSRbP0{)TbCvC_wMD@RdV{4oP7_LCt5M?yk+x&#P4)wKX+0wI#*HwR=C^ zQ(InErjIqwz~l(W833)8n%8E&D7`K{T^7GKTO4;&&N}JYp`EN*Jl}AV0WS0NISdTx zYv)d%EI<9%guFd>rpgYw$oe%a{O7&=f;uQk*`@e_$H_ z_N}FVug>z@-d9Qgo}J}^?msa46$@XD@{iJ|qffuCAf~=zHdi%*I#caNDt3-@7lQ^(%g+=M=8Tf#%l4nf3}l zQ6N59(ZCarGr^1c-$vv*LHnBn4dz(SDZQ0}FS>zdk#p`n7Mg zLQ5CM%*4z4T<6AH{U)hUL+wRmfT$H!f0q!A-kL8M^au}ZO!|XW0AoXhz zl>r+?7S@Vl`yu0&l$6Mh9ouEs&K(AOcJH=6Vj?m`;lP0dvVGhC$nIS`rL3&fWam9{ zF(yA+-~lh^N!!;Rd!Zz4kJZ?lUsxnVe%Vj@X`H^X(>LYCzmAmm*Jqm!7#FCjtQ00V z>!rzZ!xiU9pUb~46GjZNfzXwWRX>01Im**{Q)AbZBy@*VzeT!N4ZO9R^thmn^t|X) znepr>*^;wfbsMaW>Q?7kW<)dpK2dsHc#3rSb}JeA&^^|tn}yHc^$(9I&uAOJp(N3p zTAmb^l*-^c`$(^gPnF)6ww0Gd{yr`?P*qiFL^Jdw8GulqgADxkp$i2p{ zLhUmw&cCVor}(4SYSlq*exVGyy@%-@{?q>Y7hV5#Qdn3Z`}XaVZE9~hY7aTt+49nJ zPfMRm+gVQG{57{b8vUpEqyL(kYAGrylZWo;W&D}jKc+k3bGkfs|1C29u^}>c*uTrTM<0}NzyA+;Mq&K$ zAu{}d+f4t=f84MKj6ZR(x%}~K;?Ki(_BQ{+w`Wg&RzCUQ1KGcKuk85b6WRLyX4$xQ zjrzp;i2c?3A7eC^e~qp|acQ~PU*P|31OLljXFgS}{()_m6cq`6KI?@EVf;BsMhy=1 zkNt&l;;8JO_)GjLEH0ISq5t;^gX>|nV>fK74`qtDg7507ah&~ zQ}LJhLySfLLHs?_zmMoYjcm4Qcx$VmK^86Ez z(4{)6@o#mXKYM(XCvDFKQuznE#cr@&=2xzMR90G|&tV_^3g{L&$W_c1b-gRf%WO|1 zhS3jbX)6ElT*&jUr0TWKcqXZY=+duZPK?_$^tScN(uIz5)FE z1ADpl)RRqn)?o$K`3juPBjdo0Ukk8m`9#Km&vp?r=U?$`jt4Q*>0gMtIt;|T(8hip>J5zZZ7y3jLF#WaJk`~wjNE*AwmZ|bWYn*+pj3(Dje?u z4|u^dE{Dylu{nhJPGh**_oPC!kaLiD9uHvbXo0uO;kwKyehklXXNH3@E+5PB@x#|G zTE%%GgX`4gYA}Zo2RyfT*L$_*7ZlHTGYaePz0QQ>@1nKi(HARp1Rnr_4Mb&YOn&!y zY>&bib>z{dn!l1$ljG*+=iB!c&v|*dQe0fDb)FOy6xf*;H90bQHn`A`^ZNV3!a}1d z((glP>8DLT?lkap{xr0>KbVa13F!Oi{O})&9k3uL@=)NxbEe|&!tVmZb2{*8`@1MT zy7zwP6#9$Opa zWBQ)GkNFXUDNbj+(GT)-PW|ShMRLcrm&q+xo+r0oeTkmUo-NOg7$&Rr%rM}_A=<_Karxse5q19^Lb)(k>au-8#1=apnsR2 zeT0%`B&@5i=@LEHyXgnt(zDmo!gI9~WzwIANzTd@lCx@gK&`*b8GzR9qg22D#{B0a z((Sy~()YV(*!kTZSDmM4B?SRp=*P}09L!}ww#MZ5xWhh5aT>E3{1YG4>uq`C_18@I z*I#zJ-E(%o;1rpt@~>a9T;~wTkKQ@s$M5mcz(%U<-0#Up2idvjjUCUjv*%x4+d=m2 z{mg8OHFkRo#7L6`*~|x;(0|{ME+v1|zj(KN*-~3~&UE`-ai(-T|Kw2qEO~GBN+XZy zFQxyIvI^5b=kfjYOpWk#y{?E;~7#|;w6_>v$ z{Woeq@JAn<+35YYELA_nchlq#?Po)1|I9TKLsGs|P*fr#|1>0&KhQsCL)gFGpxJz5 zx@RiKB)`QSwP*B#TJ7B{5N|=mY$ieGF!2GlrY{NICxODZv9v`Y{-#y z>vLq>@S!RFV?W4Wke_RGoDDN?bQUScBtPrUy1HM@|F1XXrXPMgP5ucZhD!GGWeQ8> z6FvW3r}qv^mn@M5iu?N9Ir7Gw*|Ko%Y+1W(iTv%UKMFpN?_fX3pL<}RRH)qS0gI=a&e8P&XX?|B zo6mEn;Qm{#XMoWXv!P>>AH9>K0JXJ;xhKkWy=$5= zah$?4R=+%9oJ=1NjFoBnZq}5E^2DHDS^Px*oZS;YKmTlx?h{EnTP0RUeMjeYO!B*4 zd=JW6xlwY9@%`W)!zzLEQ+zDgU{KYJYzE8fwp z_=EmE|3pWN7A{E1j|?sg?IQ)J@%Wi{@POGre6atP)IYI+Ibf6M2KjFa_3!c{&kdIc za|zl!XM%bhXnS{PYw;iX(T&HrmW)5h%y`63cq~)tD0{H!Po{MYxpmXx2hB!;rC{KxF=x86+Kf4Qq1Irv^#Fl)NZ(YyM8Oc}5B z1ijOkB=cVSo6MUw+2GX|pEsPRhxWI7PV?U|epZC{d8J{_6x)N3$^Nk$&m-}xEX{vz z(Y!ajU1i)ITb%We|tRGzlinhL-=8C?m@w>_kFrY|C9HgYp; zUsqo&`hU$--o!U&OZ%_;E_%WK-G9^b&*iHB6@j0tzj(ZbCYcOALCPwsWbE)^8S~76}au4j6Qsu)r5d2t+NOAd_${$?+8Nc5nW7+phzkmCN#*mYZ z|Ifa8f;{)wV9THV`z4AWZS%jMQGXgNUB2}tqvcNj_N&^f{)-LGeazP@q;>h5`hIu$ z8=RkD&wggcJ@St2+vK5}eSPUcRZs`a9krd3F~j)}?*KoC zcv9OG2J$hi<4Av)!!Z&>d__MErzP5s1h-b$G z;tS?_Pm`&E^1}|5$z^tYUk7aO6$L+6*XD66&Az{jt%1+M{efrV7yASI2zw#>IrXuC zkHMIX?J*L5@OB;Y+?eXq`oW6GIw4vd2?*rx$_cul*x z;A8l>Y5LZ2k3iBdQ2tpO(Dkt;^12Q|9!n&usLxF#^uI*KZI*Vt$h5Din U^sq~-sD4~;u1D9a>)Gr71+W*(;Q#;t literal 0 HcmV?d00001 diff --git a/website/public/favicon.png b/website/public/favicon.png index e12e3a0bf7f418b9dfd3b8687c51b39426690b94..d03bbb698ba3ca642812f076d4cf41be65a6093b 100644 GIT binary patch literal 5565 zcmY*dS6may(@hA(0HIwG0^|Y_6ha5-pwg>UjWlUSdJ~ae1VSftRFo$D66w8n0!kN1 zq$3DXI#Q*6`9FRSJ3CMNo7tUn&dkOd>TA-`u+snl06J|gHDmH_^S=cFlkG}|uPgv? zD?(dM`HA1`wxwdk257;fB4RsZd)NEf1obCXDi*9t{;0yj7@D z%?OKscQ3dPEDh;nnW?S0V}AvJm~y}9#zx*LtcDU`E+5%^z3rcBsNq-f?eEp+z3xdU zNlkheZB>+gjTw|B%^#eO@`TQLx4ILzTPzzleHJPlJgZCmU%70bW3;dfL10&I zX?i?2^hrI(ldI$(l|tPz^nJuzaYO63h>EWbgNq${hhBIM%)pkNSx5qFW= zJG);;0avwZQ{0Z*^RCjE^nX+!l6n|k?F&NAqr0+la>^*wauyF%^-YiwGmJj^s@B_5 zRfoD<3M`}>MtOgIWdYBlLDe8xOW>=Q)A^Kld z?-GI8_m5xKh{~;ezGcltFrV_K0}R$cjdczK%1u5NBh!t4otzu$C?g|%7yWOPl$03i zARrXX>Oef~YYin}zCDnb+sIF2@X4x@{6pXFIV5lkYG#UpPPausKBaGiW0smA zC$*W0t66AScn=H{(%IRj*~^HB^?7c2C_+^!l>zwgsmyp!Y_Ze3#DrCtPHEBDM8#@W z;QFLo0e`qL4IXwqBL=;H^ZfEbICm(4-4otekv$hiFjq6GJG{Js>HZeH^J&cia8Vkc z;VWUwbxRF#!qs$B=6nY}yJGTp;Q?uD7D2^TVRn)hj93DLfF%7cOC5_ZT^(Jj3K71lS`@hAL zrNn8ck0RU2$L(RpQm+eaUW1C9VGEyx)^p5Is2?jU6eyIfbf$2rYWdN(b76{0am{-7DXmUfc_L_V<#dw4d~+1uHE1qN$F z(LzGD5i9_--%j+-O6B!WFGyiu8-FrMjtq$OZ%YN@_|7FI(QU^g@f+w`KJlK{dzuP6 zgtPKKIWQ)SF9bfIt8q}?xTx~c?sWalrA)`c`ZXev0_M`qhN%aTpa=OqLL;90@eeT? zE@Jq+bQRIW@y&j6m9>_=;BWm$TSR~@z}RK=3(O<b7oSb7B+DrBRMg^x}3QqAc9igzyR14$nv>ic|>MO4F<`A zp2tv7PtJVI5{HaV7_1OjWEE_%q3INW-kF&hbi}Wgh{Jo$@9JtKd;9yT3YTH@|M0dm z;)Sdgk|{2EH5j9oRk$BKI4Qez*l6%z z{${-sI|Pwjj11@AGu9RnrqacVlfh2<`|Bx=&BEmi3_Y%w*+$z7!8;CO^v2c-6)qeiz8OhZyr>0Et^=AzHfQ z(ho(DO2%hA9e95Shcl0B1AY?H^~HKi54tx32?0`O#PV5-g!NX1Esbpe8k+>ywoU_P zKDwLn=KEHB7kv!;n?2P8rZe&mG*Uqt|aM7D2OZ-TFCo9ERxFP1a2leN3>r18mZwk z1`Oyg|F975xlMns=zZa+X(%cDuYf?&{Le5EHd_SCB7JF=NE`=zMvQA3^0-f{5{GNM zh62>hWO;nFe*AL~RVk$FfkoD?qi93Fyokf$F5_|T3Q+laROgj)O$=uc%&*{ub7%8Q7g5NW0tHXjjFI3 zAyrG6j3Tx|Xo|fTcHnW}r2?Y_r8E^rzn#peiucG_XKl8b==@o50FdTME=Y4pJa^pf zTxlr9?>7(nC^*neQNVPXl*0fUsEE^O%9w8YwCb=un}`GQD^A0VAiQ2+0gtI=`8nr* zXAuubMSn5f{g4{u%f?-Fm0MVF67N7K`Kg8C|(V`}F{B#Ej5; z42@PL;|hZKluj=r54ZRXaX?d-h}f5xyjD@3t|t#$Q7vh*;mj06PCFVM*~}R zMPuK~H4%)o`8z+!Y-OElAHF8T3Elhsj4BZFmGj3b76!k1_38koRFQA&j0EJ%bBIu4 zr8sOMF2WSZ{pD=U(}T{-*_%v3Y4)-C03&XqM5r9f4r?XRp*P75p~xlvhuav}iQU8$ zAnlq)^*Es5K>zD3FX&l&Nxnz96bHzbR_WyqM!}_Are%ToS2f-K3RcMvkHp~gp8o!^-8RcbcG9}ynInco@A#;iOyYnt zlP~HmQwvdL3=`Ql=pCx4+&y>m$uKERpM7Rv)It4|J7gGI&k5JnX5-#@yu{em`8`=X#V z&k{7PE`TBPW1Y#|XiD#8aDtcv+!n^2$aCFJTo_8I1AaygP0f!BBX}jf-V0>1PCvF) zVx~&AIOrkVi+LsUgh3JpHDvC8`y;(%G_<86*s6g)u4qG6C#&uQ?nom;96aqfufVlJ zdUM8?m*AbU7cP5P!Eswm=%y>vlX5(a;`(rR34gN0$@7eZ)^wLtQj0vh>=3l|;CKkJ zs@!BRnE16WPKF1$Z-hqo-f`Mte}SO<4wg)>CNu>vUohuh)mv{UF`4GO%4C0eXIiC) zv*2HuyFQ03U0yLTMs|PP?XuCcP^@aHJ-@s{r(7jqL1f~)fzMbfe$n=yN;qy^TEMo> zSupdxq24O>{DwPdbPY|%y4h>jK!LA^B@yuZuY!5!!Paiu{Mo8Hzm@x`YFs>WICPvN zc-vjtSgbR)U#eQHbvLUjuz_G0C+3Y;GWu^JvVIf(o*qpBS6y6?8Q#<&ZjzDmh}*jb0!4D48`-RsD1}cOh5R zZx^Y7RnN>$Z>q-g9e#=-1Bot!b=R)Y11 zuIb}uG#uYLt4>O)gE8GNf5peo%@QKF%}qkCEAEAktHk-0hNQjB<8}-Tw$M5gQzd8= z^fY$pAcO5ByY{~6J|uG~xp~5`iq{CK=a3j7hOBm(gH8ce#WPqJ3tIdfjf=fhgl=^J zshfH_L0>y3JKJqbT2Vnkv-28cee4O*(zx~2!NFlUOH{(mJwby{cXv|KyGcJ%Qg45` z8&p_}#JWq*hOyAOZN{}AzlaF5h+W7`fnU2|W(Dr8-g};@n4bM@NltW)t);zxA@QW8 zVvdD}SUD^=aCv?L#P2;kfVVD>G=QBh@81{Z397qPvrM&o{xINha4yPSX7vaET91s0 z&i{H+Z%ZD%$)d#5Vkbjps*lCpuF?lf+AayNrRQco0cnX-DR~tx*a7sEcf#MG9mEm3 zvOt`y#Mpt=qPXWsvNZPuS$z_Umxd@PT{p_V&l3_Hqr_Q#lFt+AEyX57@2=%<;uf3t z$qk4`BNZOEPw7xrF7>r$%bojo{B`_j6XONPK zaZocpDm+wK=x}(jXQcG=^9&Py8FJ@bLDuv_>oqjmusdgw6CuGkAuC?9eHw7o$-A)9J;?oyGRe#EC_z1prk&R(hKs zGt{ESNco^w^U}R`2CB?>y5PM!Ki(9EmCS0L2o@#tQpe@* zVaqq!$(5q}h07(3pN94LdHmfn9D7S?aJk?%T%a^s+i}ggvPQ-BNY~*UZ{_0* z==a|kH`<8;{#W-n3mG=&o)*!k_{WD=tQs&z{3@nucpIITvZGO%MGNU@+Ien1^ryag zIoa4%vSkh)`gwed5v=(AD6ApVQWS{#jJYV2`p-EM=l*QJ{OGm_Ow&xtFu@ZwI?pAO zJ2oLnhr|78{X8eyKwt8^SUq6^0NT(fD7zK0TmhaE0Y?t&{`9Xt43zh^Y!ry~>C2he z!=S}N`A_j8@NVs;~myrh;2aX5YOi?aG|FJH~meb${kRw_e15VG)d zl|3XM#^rzY;G@QmmHdBWl~zaA51JdL)Qy%G+XK%Xhh>h9)XycBEljbi<}T{UJ^wPv zd0Uw*ub@2)S0C#elF6q8aGCo2CIYI$KTYqoqVh>V*Yy4XxAx0dsmnZESCFRMj{h#^ z^C~>ItT2kK8z}H>!?*4|%G~oqQ6;%w`8XFX#5fm}Q7e|!I*7@09>WOlIg&9n)ZD;6 z+ujjs@y_66xk>buSpLN`^i(s%C_gjK2dU%6PKRU_6QwF0PPobKRBUA(-c0Sz{bg68 z8}Gm}xWm!^UYeL*#dpH;X9@+_P;hDy@8R5!xkf*#2bq)+?p>GlNUq=}DAndum|jsiODd=xp)abVR#kbC~q_OBJuZNbYx1o~g?yNMy3+i5(6MA1dQz`9D&OI{G_M9yb& zsY0wZ-EluKQQGRvH+z*4oID~1xZ>Qd+j9sGx-T#3N7YqQB~fu2%U0DxDc`Jg4v0=# zJqFU}c_};$>#y}nJOM<%y~(sM6`JeCTKxC#G2897{*}Mfm3hGt)b};*Jyxux5UP`2 zUIRxaSy$*W08h-`@WO#$B3O4U$zOo2`c~qGe)2xjAt;WXhnQ1b8TefIZ zAh9WNz|>9rYvIQnUy<()`&S{!b0*meA(srV=6<@b92-TM+`f9tR%ItM|6uq)o~_E3 z?2I0hok*rW?A#4`>l+|?o3DWe7c;egBJlt3*K^bSn!%gqX994S#h?5w3(!{ASF2F5 G3I9L-G<%=` literal 1253 zcmVmajBw4!>LH`I{WTQmE zM??vz*~J87&}1~P>FMr!tLnJ8bvr#F(|Hgy1x?-CU0vT-=X~c;!YvGU7w%w)h~IS0 z5>N#cNVl@l65ad$reyaqf8tli9F*KbqitH6)I zry}xAzxR&ja(64wNBr)OBV}*9p+y(K54*dkl%l)0-Q%^>s77~XS zvF0XqcN3B1?oR{X0dYJYTV2-z5MzsoA_5``KuU?hV8CoP1E8*Jnx-M8NC*|+gisM< zBpjYMNFBdO(24Z5JDiOL|xZN`L3!eQihZq zM9Dc**EPf8P!_ata1k?dP^s=8ym>M{bVf@dejhy&R(?%>(++?hS+ zOiGEIBJP=-om^ZZBD8Hw&iVEUs46i=R23~Jg$@t_3syupplu@KNdr=C0|uz8ieAh& z8evHqCFjn(BG(e!>S)O7%8~Dw6O(uRBdU|SZV=PxuN-_&sIx(D+umh1Za1rf$4PCiBJ^*VoJR9 z>=Qil@Iy3h#HDNvhGH>L*tNcfJH!|XVVelI7BTydD2PaO_m6-#fz-BbFf+#EF&8#A=ADqK zvcCQxgTWB@?WVna`7&3oZW2OZ_wHQ`>Y7}vSl4wd3E^WAIoM-!CTj-qq}$xSal%*Yke?WE$HegKJ3j P00000NkvXXu0mjfB2ZKm diff --git a/website/src/data/docs-sidebar.ts b/website/src/data/docs-sidebar.ts new file mode 100644 index 00000000..c966ef6a --- /dev/null +++ b/website/src/data/docs-sidebar.ts @@ -0,0 +1,20 @@ +import { RELEASES_URL } from "./agents"; + +// The docs sidebar (astro.config.mjs); /llms.txt lists the docs in the same groups and order (src/pages/llms.txt.ts). +// Groups start closed; Starlight opens the one holding the current page. +// Each label with its Chinese, as the App's zh UI and the landing name them; the pages under each come from +// their own titles. +// Getting started stays open: it is the group a first visit needs. Troubleshooting and the FAQ sit before +// Contributing, in the order a reader with a problem looks. +export const DOCS_SIDEBAR = [ + { label: "Overview", translations: { "zh-CN": "概览" }, slug: "docs" }, + { label: "Getting started", translations: { "zh-CN": "快速开始" }, collapsed: false, autogenerate: { directory: "docs/getting-started" } }, + { label: "Guides", translations: { "zh-CN": "使用指南" }, collapsed: true, autogenerate: { directory: "docs/guides" } }, + { label: "How it works", translations: { "zh-CN": "工作原理" }, collapsed: true, autogenerate: { directory: "docs/how-it-works" } }, + { label: "Reference", translations: { "zh-CN": "参考" }, collapsed: true, autogenerate: { directory: "docs/reference" } }, + { label: "Troubleshooting", translations: { "zh-CN": "常见问题排查" }, slug: "docs/troubleshooting" }, + { label: "FAQ", translations: { "zh-CN": "常见问题" }, slug: "docs/faq" }, + { label: "Contributing", translations: { "zh-CN": "参与贡献" }, collapsed: true, autogenerate: { directory: "docs/contributing" } }, + // The landing footer's Changelog link, so release notes are one click from the docs too. + { label: "Release notes ↗", translations: { "zh-CN": "更新日志 ↗" }, link: RELEASES_URL, attrs: { target: "_blank", rel: "noopener" } }, +]; diff --git a/website/src/pages/llms.txt.ts b/website/src/pages/llms.txt.ts new file mode 100644 index 00000000..cd3734ea --- /dev/null +++ b/website/src/pages/llms.txt.ts @@ -0,0 +1,29 @@ +import type { APIRoute } from "astro"; +import { getCollection, type CollectionEntry } from "astro:content"; +import { en } from "../data/copy/en"; +import { DOCS_SIDEBAR } from "../data/docs-sidebar"; + +// /llms.txt (llmstxt.org): the English docs in the sidebar's groups and order, each page with its frontmatter title +// and description, so the list cannot drift from the docs. The Chinese pages mirror them under /zh/. +type Page = CollectionEntry<"docs">; + +// The docs overview's opening paragraph (src/content/docs/docs/index.mdx), without its headline. +const ABOUT = "Each AI coding agent keeps its skills and settings in its own folder. HarnessKit shows all of them in one window: skills, MCP servers, plugins, hooks and CLIs, for every agent. One click adds a skill or MCP server to another agent. A security audit runs on your computer and gives each extension a trust score. Kits save skills, MCP servers and rules as a set you add to a project in one step. HarnessKit is free and open source, and runs as a desktop app, in the terminal, or in a browser."; + +/** A directory's pages, its index included, in the order of Starlight's autogenerated groups: `sidebar.order`, then id. */ +function pagesIn(pages: Page[], directory: string): Page[] { + const order = (page: Page) => page.data.sidebar.order ?? Number.MAX_VALUE; + return pages.filter(({ id }) => `${id}/`.startsWith(`${directory}/`)).sort((a, b) => order(a) - order(b) || a.id.localeCompare(b.id)); +} + +export const GET: APIRoute = async ({ site }) => { + const pages = await getCollection("docs"); + const link = ({ id, data }: Page) => `- [${data.title}](${new URL(`/${id}/`, site)})${data.description ? `: ${data.description}` : ""}`; + // The sidebar's external link (release notes) is not a docs page, so it gets no section. + const sections = DOCS_SIDEBAR.flatMap(({ label, slug, autogenerate }) => { + const listed = slug ? pages.filter(({ id }) => id === slug) : autogenerate ? pagesIn(pages, autogenerate.directory) : []; + return listed.length ? [`## ${label}\n\n${listed.map(link).join("\n")}`] : []; + }); + const chinese = `Each page is also in [Simplified Chinese](${new URL("/zh/docs/", site)}), at the same path under /zh/.`; + return new Response(["# HarnessKit", `> ${en.footer.tagline}`, ABOUT, chinese, ...sections].join("\n\n") + "\n"); +};