From e6901e4f6e367e9465501d0950cfd1576c3702d2 Mon Sep 17 00:00:00 2001 From: Tiara Rodney Date: Tue, 10 Feb 2026 20:57:47 +0100 Subject: [PATCH] new --- AGENTS.md | 6 ++ CONTRIBUTING.md | 100 +++++++++++++++++++++++++++++++ Makefile | 2 +- dist/doctrees/AGENTS.doctree | Bin 28431 -> 31017 bytes dist/doctrees/README.doctree | Bin 44309 -> 44309 bytes dist/doctrees/environment.pickle | Bin 27696 -> 28086 bytes dist/markdown/AGENTS.md | 13 +++- 7 files changed, 118 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/AGENTS.md b/AGENTS.md index 53bae1b..475d30b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -40,3 +40,9 @@ If `dist/markdown/` is not available locally, the specification - Do NOT modify the RST source under `src/`. - Changes to this specification MUST be made upstream in the vendor repository. + +## Maintaining This Repository + +If you are explicitly invoked to maintain this specification repository +(building, publishing, or managing URLs), see `CONTRIBUTING.md` for +instructions. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d8f7d57 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,100 @@ +# Contributing to the MIME TODO Specification + +This document covers how to maintain the MIME TODO specification repository: +building, deploying, and managing URLs. + +--- + +## Prerequisites + +All build and publish commands run inside a pipenv environment. Install +dependencies first: + +```sh +pipenv install +``` + +--- + +## Building + +### HTML + +```sh +pipenv run make build/html +``` + +Output: `build/html/` + +### Markdown (agent-consumable) + +```sh +pipenv run make dist/markdown +``` + +Output: `dist/markdown/` + +### Both + publish + +```sh +pipenv run make all +``` + +--- + +## Publishing + +The specification is served from `specs.code.tiararodney.com`. The `publish` +Makefile recipe deploys both `build/html` and `dist/markdown` via rsync: + +```sh +pipenv run make publish +``` + +This uploads to: + +``` +root@tiararodney.com:/root/webserver/srv/http/spec.tiararodney.com/mime-todo +``` + +The resulting web structure is: + +``` +https://specs.code.tiararodney.com/mime-todo/ +├── html/ ← HTML output +└── markdown/ ← Markdown output (agent-consumable) + ├── README.md ← The specification + └── AGENTS.md ← Agent consumption instructions +``` + +--- + +## URL Management + +The following files contain URLs pointing to the web server. If the server +address, path structure, or spec name changes, update these: + +- `AGENTS.md` — the "Consuming the Specification" section lists direct URLs + +If this spec is bundled inside another spec (e.g., tiara-gitflow-spec), that +parent spec's `AGENTS.md` and `CONTRIBUTING.md` will also reference these +URLs and must be updated accordingly. + +--- + +## Release Process + +1. Make changes to `src/README.rst` +2. Build: `pipenv run make build/html dist/markdown` +3. Review the output +4. Commit the source changes and the built `dist/markdown/` output +5. Publish: `pipenv run make publish` + +--- + +## Rules + +- Do NOT modify this spec inside a consuming repository. Changes MUST be + made upstream in this repository. +- The `dist/markdown/` directory is committed so that consuming repositories + have access to the agent-consumable output without needing to build. diff --git a/Makefile b/Makefile index 4e799c8..f40eef4 100644 --- a/Makefile +++ b/Makefile @@ -13,4 +13,4 @@ publish: clean: - rm -rv build + rm -rv build dist diff --git a/dist/doctrees/AGENTS.doctree b/dist/doctrees/AGENTS.doctree index 8bdfec24537f7918d91126d101965e840ebe55b1..dec042ee158190a9b5387d331040005bacfb7f5d 100644 GIT binary patch delta 4299 zcmbVPeQX>@75A=v=d;r!4n8}HeX-Y$W1qjyPMZ&KNP@p=B0Fc-AH<)H_wLr-UEl4R zyFD5MjtdA-%Aq8k1+_wy7AdM)5kYkVT2!QpsuhBev>>%8q#+F@iJdfw!$;L961>@+ zx!X0D5cQ9HZ{N+E_ul;G&6_tz&oeLFVjPbql0RAf z#F`P8qDBQR9#!4wb+YSEb_~j zK=#X*QB&Ktszu{_2~)AkFJFa^BZ<6&K~V~aqJpAN=<-eU?Y7;_E%ZiP1<=cFm78vX z*1RqkIxrL8?9PfOvZFB#+m~;l>h>zo>u%q~)F7#SYE2!efphs>c2<_$fZl7bDB1yk ziB5UNNMXkoW*7QQM^keRjLVpa&Tr{*GnTee3D1>H12DD=OS{lh9rH|2vba-Yn5E=* z9$w1XxU*Rob0>7MAd$TlzEdFo8a>y$9-Zhuz??F^+&z6IuY!@py2sRLD5%C2tuZ1g zaZQNn^6!&}drFywM5$#vIJ_O4Wjk!6|GQadAP4aaGj1%;#x?QQU z&-V_qpK_w-T1wEXy?>ly7Tc|Y<7#dJsyx*=aYSZU@Fn+z7e*;G*)LCTSJUh zqTnO7Y^4*uFLNd2)Of24;nzG$jS0RH;e}Hz{h`Y^VGfw7lSxrzMvWse44~Z`KTIF(CmQIch4B;p-h>< zVb|Szig|YNmjB$gB}HUsPokFs<*0cihvG*EUUZ^`Ky5x1pLe3SL!NpYoI|bCf}(Mf z64RpbAciz{KbW?5b@~SfY?!(;S+W3o<`V*oW(HPe#55Jd{bQP*lE(C18>Yns(=#hE zr30r-OsQyMT4uv^?>;3Y99jY6Xr?_*XJjs!V*zaW{{XgwW+G0ZEt$+yU~HNd88y>* zd~CyGJ;7snB_4F(x`9U?6`u#aoeebO(v?jRi*Zrg0QV`b>bzJ2casOCOX!COIA#&O zwZ9y_cc7IiNBpC8YsGq~)fwkabWp`I@hC&?}ZD)G1p>?E0d5EE|Ty$}?g$0J|y}=66z}Uk~7rH5=+*0ih!!4Ck zZfnNB;*Mu>`-|}|X5Q+yjJS>GqLztmOx)^(jzzH(bb8Xoq#WFt2r)mf;!sZPJY@t# zrIh~lN1tJSX4U72{z=e(Fm1PF($BnM)vF+SzcK7mDP{NHlOl80s$WU;-!=59l+wS( ze}TDS)!$6?uNnGOYCwzA9A5+o%Edr%zgG+`7o-H;VGlt!9OW-qrefOn{M1jGadbhhFsK^^ zr`NONHWRhP<%ns5ieO@Cx;!J|bcL(Pnrw()wIPoCI2+;w&=ley0^(fHz1{+(WxbF0 z0=^EvVeH#N16kDLsSu&Bv$PCPL*F!~#yLJJaKfS4uoRTE@EqKEUs7j;5T~geZEwxq z7T@ft4#U#v=6eHicox7Lrh%J{2f|WJ#NP{?8U+gqeh^J_L;XFm+6FEr2;5|QuYa(A zU)#{&K7SX!E4e8(ns2>oeW{M5>yyX0QB^EKTC(SukqVf)7krsxzgy^5D;bj6itgGK ztE88X?f(K;zQyLV#yMytwbw`X?^tU8pgqjNU|FVE7E`*~j$!)lI%Xt$2Wcaz-E>}9 zip7Vv)WwevTk1BTQL&P_gXTqHG78Qjmr&Kv*87ff~$nEW?Pu48foh`2$%iN9Y5m+->9 zV?K1>1PSc@)?~jk*(sBqHrZ{^1eLcz>Sp9WVwNTU37Gs2ka^h1eqF9R3*Vr1&Sd9- V`Q^U?l`mlOK9-?4XU7A+{{n4KWoZBa delta 2608 zcmb7GeQXp(6u;T_K6*fH>9t(x*R_=9uCxWpXHiU>wje3}q^*`v+P%9id&70F?CrLo z*3U?SxrESJPz<7INK~*&ED{N%n?9K`mmFLb9N!vZO_3Dxxg# z{+?jS#|NXkb4zlQ*Hvd%M88`3JVNh9m#*qHlP{`wq2y>y&2@xMlex8pbIv52Ohog% zsts#yF|!Gef!&19leXHW#TWJQB`U?@CVUwNyCNw)J~0sV%YvkJYxoE9N$qNMmE5i^ z1Zl4;%DW0)!y105D{-vBq(+kDutM?iRkE(G82qHVJY*%2y1rDq*<^y`cp}MU!ZSze z3p2A|MzrAg1+u(;KFT4R>K87u!aAlxwCvPy8nx05i^k#@0IcOuD~Ft{A4X--sx=Bi zm!hLO#%=;xg5Xe=`%I^$IePC2d{EPWa9RX*P?Fm&))=WZGS`q8@QJPg zIW!pX3t`tY?TzbQ0m(0H2SX8g#pUBAmshYWGCwHDVZrZGLN3Z^MSyj|#SaVw13umx z6kPqhywx8Xl3aa(pb)MgzqUIaRf#r|(y?Blt1JJ1 zALFs$h?lS~7V=GxC&e&7AosiSXu#~=FCC{6o%7A!T69iF zVqMK84EqXXTaSls- z*Fui_mU5t`r7;$7(=?0GB>Z;2pG&urL(QJadmxwLq>@%|<&-BD4ss>&o_Wl39(b0f z7}g~AzP={z$@qwT7O|2>kQTpf3SZtLaxL-R1eSUjR9GOVdYkAk0ZKUsBB>MDaw^v|I)(=bX{f**AZ!vc)f?)*0VB9w`TK|ptK z7QDI8AY((Xvn|9m_i|iw>GKrV+#(W^i_ioakukaveJop%{)sC0P(Jy5TcIu;WP!Ta zk#9@TpaIpxRoG$_W(`VW_2-joYB|aukr!~c%w*AErkma)m@)v6khL z3V%z*cT`*fAv*E*bo?jO0RJr$vEP@!z=8yiW9sjiLN?PzI-3Mr2XzBnL0Q0RK-fx^ o3EM#786bw?9&OX`6EFm)^q9&3)r1`&aV8a6)CL|Wsosiz0GJVg8}8yK4>4Mh4ztEk|mpL zuwkdu-!uEL#5v>C`FGd^V>E%qM4fJteK92Z$wbK(iCZ$45KZQN4=BUWvRa=TzUTlof{PP1V${?nHke$O#iczZgjtJVB0iJADBc>k}g> zA%PXVE+-obaX~?hs9k~4F&`HeBk_ZQ08LP{KJT!f4T+H*-cfeg>t};6Zh8Yl(T~&3 z+O#ju3|&5IP2h{;6pC4O>7wWIXQeL@@{B)RE87eA*jTS$pg*sFIJ?8+4P`sH zu|UWx1Ss1{@wj+Yqme zM(XmQHHXPN6qAX?+DZ(V%E%3hbKrNA0c8#KxNkfl$J?=D-a}RqS8pZvVXxmGe{Z9B z`UF2imv;V?Y-OdZFbx#K)R_-;!!zV|to{nEe-^xj0n?a=-z;I}qbkhVwMez}5F_-> z9aymB5d$u^Rg-dR^>|R1Bqf;#jAVtf%8o5XiEfob5gO$Gg0-oFHh-+CASUdw{}JYv zm*ToU<~RYR*SWOISI*E=@X@Nvjrrw=lSE-HTA`w$Lvv zS?I7au($5Rf^A!<-j+uGq)j>Sp6vl(U?$UiZ@HCe;Ftl|7N4fHN)z<;W$)Kq}2j4n3ystYMavIr(9eCHNQ%K;=iUrb;=gZ@2=dV+joxcIAt6cM=yk3&+`ncT0Yc37> z371@ZNf_5$S!5ZvTsmrZx^uM4G?Ug@lm9$LEsBXqTreca?8~sab7@|{tyQKZ;uSY% zNljEJXl=epdMwiDCX#FmxF>vEcC+72AG#TFa7K(Igg7?n@`(IXG{aNO{|ALiE|=)g z$30t;LKAq&c#5Y*ez&xHd~+v(HyCJ4C+&3jiaSZlqV+=pAxqKEhc6LbLz3QLC^1x& YR_gWQDVixgoSRPlfztBmxOYMMFXNRB3;+NC delta 1336 zcmZ{jdrVtZ9LIYueZW-Q=B67CM;WX|rScfoz)&6qMoTMjw*uu+Zrj_(O=+=@q&_er z?7>zN-S@gjvSjlQjWJsWG%ozHxM)a3{g~DDsbB9MpgM1>RaZxd;bcMq~F_{|*NBCGg5)za5#{3bU^EiWHHy2Eu z+0afO@tAw0PO;n%N;PlRAV#AyD1H^$l_1B37Yn!`p zYDWB@!wv7C=MMqY$$YmLMBaQs9wHPn7urRjiakC}CQ2APa1v=}MxU@&jd?YPv z(?N1gDup8I5-ww5R}DSz?OkR6pU0%i=9z7Olr&D38132j(87S?O3)H;$1TfPscWtS`v~N$GQ#{i`G)??~nyM&fC@_Ze^i;b`zGY z3C1fC|4B|+ndH)UQDeNbi1{N;UGCgYZpn#ms$l6E#bQ?hc?hrByHV4vWj3h6wbe4~ z)TnH&W%AYXw<%?d@NE~1W9)X=yAv6CdiNt}VOiYSU4r-71j)zM{>tq2QTu;~5bUL7 zoPx%fmt_cf5$2vlCxVsU{>WxhYq!Ulwl)qt?hL%+bgvTr-sIPk0M67k`J`(yGpraan$cQgtG#IkW()eBOu+l13pvI%Ff z;Mt)&E6-=-G5soL>3k}g=XCq2XM_)lgQ9Q_TlsC;UJ906%Bc$#rI$S@#^Xswh|2Es zaPwL+kG*_x;XHMrdA^c={N)x!Jed=T##Z+&@FjHLk9;Asq(QEizyCVjM>7g-(qsHx zgO|KT5B^Ctzd`tKY0g_h2(Eaas92&K1ZnUa_KCtRX|5AY<-(K=S m>bx&T$V{p-@D|x%f%zMCkJoPi diff --git a/dist/markdown/AGENTS.md b/dist/markdown/AGENTS.md index f27ba41..e3e2e27 100644 --- a/dist/markdown/AGENTS.md +++ b/dist/markdown/AGENTS.md @@ -16,8 +16,11 @@ access. Do NOT parse the RST source under `src/` directly. If `dist/markdown/` is not available locally, the specification (including this `AGENTS.md`) can be retrieved from -`specs.code.tiararodney.com`, which provides HTML indexes that can be -traversed to locate the applicable markdown files. +`specs.code.tiararodney.com`: + +- Specification: `https://specs.code.tiararodney.com/mime-todo/markdown/README.md` +- Agent instructions: `https://specs.code.tiararodney.com/mime-todo/markdown/AGENTS.md` +- Index: `https://specs.code.tiararodney.com/mime-todo/markdown/` ## What This Spec Defines @@ -37,3 +40,9 @@ traversed to locate the applicable markdown files. - Do NOT modify the RST source under `src/`. - Changes to this specification MUST be made upstream in the vendor repository. + +## Maintaining This Repository + +If you are explicitly invoked to maintain this specification repository +(building, publishing, or managing URLs), see `CONTRIBUTING.md` for +instructions.