From 42f2da172a435ffcb6e311f6f240d6575286c0a6 Mon Sep 17 00:00:00 2001 From: Thomas Walker Lynch Date: Fri, 6 Mar 2026 14:21:09 +0000 Subject: [PATCH] docs to new style approach --- .../document/00_Project_Structure.html | 10 ++++----- .../document/01_Workflow_Build_Contract.html | 20 +++++++++--------- administrator/document/setup.js | 1 - developer/document/00_RT_Code_Format.html | 10 ++++----- developer/document/02_RT_Code_Format.html | 10 ++++----- .../03_Naming_and_Directory_Conventions.html | 10 ++++----- developer/document/04_Language_Addenda.html | 10 ++++----- developer/document/setup.js | 4 ++++ docs.tar | Bin 0 -> 30720 bytes document/setup.js | 4 ++++ shared/document/setup.js | 4 ++++ 11 files changed, 46 insertions(+), 37 deletions(-) create mode 100644 developer/document/setup.js create mode 100644 docs.tar create mode 100644 document/setup.js create mode 100644 shared/document/setup.js diff --git a/administrator/document/00_Project_Structure.html b/administrator/document/00_Project_Structure.html index 61fcd33..b087d29 100644 --- a/administrator/document/00_Project_Structure.html +++ b/administrator/document/00_Project_Structure.html @@ -3,9 +3,7 @@ Project Structure and Ontology - - - + + @@ -33,13 +35,13 @@

Write and modify authored/ source.

Run builds and stage artifacts in scratchpad/stage.

Spot test in experiment/.

Execute the release write script to copy artifacts to user/release for consumption/testing.

Execute the release write script to copy artifacts to consumer/release for consumption/testing.

Tester Role

Responsibilities:

Validate candidates under user/release/.
Validate candidates under consumer/release/.
Run regression suites.
Approve for quality and completeness, and create release branches.

@@ -52,7 +54,7 @@ . setup administrator . setup developer . setup tester -. setup user +. setup consumer

It is common to have multiple terminal sessions or IDEs open, each running under a different role environment. @@ -60,13 +62,11 @@

Release Promotion

- Building and promotion are separate activities. The developer compiles and stages files in developer/scratchpad/stage. The developer then runs release write to transfer those files to user/release. + Building and promotion are separate activities. The developer compiles and stages files in developer/scratchpad/stage. The developer then runs release write to transfer those files to consumer/release.

- The user/release directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory. + The consumer/release directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory.

- - diff --git a/administrator/document/setup.js b/administrator/document/setup.js index 264e6d6..bffdab2 100644 --- a/administrator/document/setup.js +++ b/administrator/document/setup.js @@ -1,5 +1,4 @@ window.RT_REPO_ROOT = "../../"; - document.write(''); document.write(''); document.write(''); diff --git a/developer/document/00_RT_Code_Format.html b/developer/document/00_RT_Code_Format.html index 5813499..1b41ddf 100644 --- a/developer/document/00_RT_Code_Format.html +++ b/developer/document/00_RT_Code_Format.html @@ -3,9 +3,11 @@ RT Prescriptive Code Format Guide - - - + + @@ -90,8 +92,6 @@ if(x == 0) return;

Never use tabs.

Nest lines under the syntactic element that opened them.

- - diff --git a/developer/document/02_RT_Code_Format.html b/developer/document/02_RT_Code_Format.html index 81e891d..ad5ef8b 100644 --- a/developer/document/02_RT_Code_Format.html +++ b/developer/document/02_RT_Code_Format.html @@ -3,9 +3,11 @@ RT Prescriptive Code Format Guide - - - + + @@ -92,8 +94,6 @@ if(x == 0) return;

Never use tabs.

Nest lines under the syntactic element that opened them.

- - diff --git a/developer/document/03_Naming_and_Directory_Conventions.html b/developer/document/03_Naming_and_Directory_Conventions.html index a490d83..d34a287 100644 --- a/developer/document/03_Naming_and_Directory_Conventions.html +++ b/developer/document/03_Naming_and_Directory_Conventions.html @@ -3,9 +3,11 @@ Naming and Directory Conventions - - - + + @@ -42,8 +44,6 @@

The RT C coding environment does not use separate source and header files. Instead, a variable is set that gates off the implementation if the source code is to be used as a header. Hence, all of our C source fits fine within an authored directory.

- - diff --git a/developer/document/04_Language_Addenda.html b/developer/document/04_Language_Addenda.html index 4ab0352..d33208e 100644 --- a/developer/document/04_Language_Addenda.html +++ b/developer/document/04_Language_Addenda.html @@ -3,9 +3,11 @@ Language Addenda (C, Python, Bash, Lisp) - - - + + @@ -89,8 +91,6 @@ set -euo pipefail

When in doubt, start with 02_RT_Code_Format.html for the core rules, then apply the relevant language section here. If a language requires deviation from the generic rules, document that deviation in this file instead of ad-hoc decisions.

- - diff --git a/developer/document/setup.js b/developer/document/setup.js new file mode 100644 index 0000000..bffdab2 --- /dev/null +++ b/developer/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../../"; +document.write(''); +document.write(''); +document.write(''); diff --git a/docs.tar b/docs.tar new file mode 100644 index 0000000000000000000000000000000000000000..dabb4ed3b470824ee13e6da1773e8c74cf29b292 GIT binary patch literal 30720 zcmeHQ>2e!KlGblMMGZH?CTB>1hmH-KzSTc{r&yn z)nIs@jr8!lte8brZ(7aL2Os;-KK^;KzyAP#96ddJ9R4X^JvusgaPaux@!{jcM~@#J zJlH>cboAuW1GWFL6Mo2hby-D)QV#~xY!;P6PmS&v_kG`e{&({G@gKf@bw2oy%V&x# zK7Dx1KU5mcCnsBazIFOgspF}RM*IOk&U6*2cp4R@u1>ao8hp3+@A3@3s*)goX{y3XgWp9#YlT=4} zQug9(){o2b@XzCDmZXc5msyql={lO1fBMVi7o()i(`a#0-bVSBDs+0XRaT2sms71P zw=}aHRTlBdRozSA*W_0k(I(R^j`{eMiA#zF>#E8tg?ymBb*L&;lgHM?xHBKTs;Ft7%r8Y#HfO zucP#hF4XhIJf3bfPmQ8VpKKlOA3oXJKib=W9DF6?oowC97Pb9XU6e^SSC4iq*|4C# zThZymV2y)U=PISuIN3TNrSK3wY95&$oW8pGn~p2>w(O~kIW%k@YxOdNaf#EYstZT~ z9&$tG?kA;QYw)nt1th1MYIU0xBlTq_gMF#SS)r1uR1-bdMU<*%^GTYNQ#I4kJef~= z>h)C56(l0A%Mu?b&?Uk+QKgbn&G1lOV|qPOWtQr6fv<|Jo=jDwMtYpg@kKJPbTN)% zy{qcdtN|a)3~TViX<~O{NW)KhZX12cHg==3rw<0w6kO3)8Pm(Py-c%$|DclA7$Np{uS zs7Rul_8{dvdZUN&J%fCoW;an9PX5#7<+H2d^~Ws-BM^%W+odW~^Z_R+TCHl2&OpNkCHw18j%LMxH?{!6KE7Wy)r%7N;${?%Lvc zYiBW53pp5NRkNah{5@C_MLQa)X%?$_G}C1c5iDVCs%bJ0He0G~-JA4wn^6WY{_*#- zqG*QNp~k7p1?9 zI?)5K&qgCKF^2h$pi70SAjYaR?@(=UijbzW=na*@i>BGI%F`M;-BT}NSPD@-^GVq| z<}xg~8{sml;y3Zf;V5s2puU0`C}4py$Vwhn(`79Q-W<2z94D#1|0PIo)tXSOQW7he zEM3r)RC)#yb+t2?H_qyLdyIKKyTR^3C7o)zVyyv;ZaGrG#GGfdSpw|D8zV)7a-*R)u!S@seqA`i z`14%fDtH$#NGi}CP2k@={I9hv zeF3^9_bv6+9OgmR3VHX-Emf4~X<|8?&C`YDZzg-lYM#egS*Z`(jT&!Hw%_gSsE^pq zHC(VtT~{z=>Iz44M|m#BR1*l2Xsn81XU9+u$RR!!rimbm4ne(2j<&1bXq{7smL8*+ zVwdWs;2E%5GQpmA>f}W2@8H;iKQ&)3TNjO_x1_3TO|PpWi7Prrw^oc`4PcJ~O)-ui zR@Jp@joq%I8!mhK0WggkS(*b{*jX;1f$&yhXYlYT+%<%w)L7{8tTj^G0^a4;i*rBB zig>Ea%D4tATzcA~zyUv&XaE6F-vmOxllbjZm)Tnx{~ryF%Q}SJAAajjQXm4}f&CCf z;J*0(2r+*v{yzc&u!;Xam9_8n{^ySWZKy+k!OKlM@Y#g_66dw8kNfD3@c(KMg!K1E z`}Z+nZGi8cZKcivFPdQqy~7I8BThCP(-MU6G(OD>;)fMZYV1lrkuVR(pN1_T<2XbJ z+M^hh`sW%>SGw5k42|*N`V{ydjvp5b05?+lT{O#6xN&8j=NaO}Tdk%M@PSA*-f{&) zZ)U++g>Ss`-%|tlg8o+k3Uvy{7VaUo11Hk?dK{qf=HWAzN=NZj#^jLnD4S8HJ{mRq z<{ob}y)D2E7^xK~I!7s>>qQkTB!RP*jJYku16W*C;Y0+eK^F=ehdVBlBse!2#F-^w z0dV?-xLlfqEad_*)=Z5HYz@H4n_UHmo$;6j9pGUH&y{fL)Eoh+&=o^5OziULmht#p zGaA^1Cy;SH@GG$jnh>-ws*qhZ-j_GH(HBqq5i=fwtF$3%u zzwB<)y$Ht*Kc36e_i-DTmf@_>!;DKLz=picrkZ)r&;66XS&eW|1$|CrbQJKvN9APa6aB(WW zLb3m>E_E@D0N$>P)L&0CE+f<{8<2sJZgdC*f()-|lzEy3qpTtqvV~>masXZx0QJl+ zv1}u&hGve-6a`F%e04Zs?xCYmFO%pkL%fXH5p+*Q2`@Hj9`t@f2t_ zv*Ja=ax%j#{I*CcSYYBf(;A`%^bjP*BCx4Zv;f46Q=5vb&MtOfh^I6io+Ry=15QH# zMzAghAkDHA=7$G$WI;zq53%eyP9TK%Z=wkZ2dVd?uUNjA18OE=?7Hi1Q{4PF6brb`P-z(<^=d~3WG8{hiRidENu@X8W-k{AVb1jlTE<~IH5d(Du)+N zP&v^i&{T59V%Kz?IE_F(bThd4;H2Zb*gPB}OpkM&rqN93&u5A_)E>twHeg=`z5y*G z!O1kbT+>WdJ6p#WN{DAwMq; z@V?Agiw9tV$nM{l@V~4JM&~VfIdIAbICgLX^5o{hjglgsJgGG@d(mVLNI!{9$O=HX zMzHF>MWmXHjT@x|FMcP!8vX#6Bq9z2159CvC<;26(bmvVp;qnVO zww7d*2QK9kQ${KBhvmux3kkLZgvwUN>sf2pNVy&K4hVKsh)9q&aG@B-{*Erz^JoEp zA1{U3Q|~N1ljz?#K?E9jv|^*#d~$l>yc<-Pm`@m>GDjm637>2o{L7C^00K_{&Wm^! zCeX2i88TJb1o4FVY$cHY5^hO~`yKu_hJNHN`9I0nT0nYw_Wy4_xkcH*Hxwpb*NsLDk-D6&o5jx1Po0}YV%Xe5EE?hOu+)-U0&?8R&I+`?6U}EAr}=(Q>YZ- zAg-i<=q~LpLi7TU$WQtmw1G@3+k+qXo3)}0=Mo`zcNn3LS0sdiL$MUYA(O~k!{H34 z<#4zK0yvB0n9sG^W1**hWX@X32{aC5fdDWWf&{$a&fq3gwf z)(26(FS*(kbOq}o-@Py!xX#<%#<&_dJbIe}@MC_4=L5{cL`np4SR0|23J989p6(fJ zF0i{LVR+Ot?p0qsgA-AjU+%KCk7#R~LO)yQl)>6>OA+JV8%WKKlrkcoXvvHBroPc} zL}aDq)CD;YB$G_lVN(wmlpXF+4a&vr1}GQdKn)lkW-a+8z{$Ex33P~{5%Ct(zm6hQ zveE#1(;>p{Sz;V8yB7FbG@It_pqkN+=P-Gxj@#jFf1ZC#%m!m4ik;~Rv&)4;}5uK0a#h8yhsNYh`wcnusD+rwe_h=i)fJX^}Fo;gREfdqDomQR3s%|pHae~q^ zyt7=f^Jxuc-iJIqy|fid#1*fl3xh$*M+J**-_GvXL}B+viA_|)@U%t+A7YksK*@0U zB@p2HnxGf;7W6iow@71GumP9Qv*GUWvK2DAFl>E@D3u8B6$N5(XczM}0V|@vAaYyR zL{|i{S`*#4x`8$gdak841U!8-tJEtzUfd=nun|ZY-}R2TFQahfjD}%SbkYzxWKENn zBxn8-y^WT6G6rl@0y&D`aJN2=Z!@RUODWNzq$Ie&_ae5?*`c#GyoSrq@QO7TIYNN3 z=~86fN6<{zMDbxap@i|xnBBI*m4O6;++U@=&(=G+ir%J6WYgWZ>Fz_e8xYk1YGRTD zFk%9HZMyq5-F+X_tGMazGZlVo-O6i+=Qg<9rn~P$V&(sj&-VJ!2$xd;@|8x()*V2X zMaEk^h7cUnP4JOLfa~#}gZ;y!qYnP_1nq#E`oG^o-aa?}V`ZjO_VfzrM+6DT>i%=P z|B(Kz^Ur?254;!yc)4pTI=2Mbx~A=hZ+*v%7l^p9Ejo8;0DA-dIQ+1A%rd;G46>~^k;@%Bj z2VfHGEViGZa1x7gVVsnVh7gi`fbRP%^h52T>H#S|76q`4C~DU~@kuk6g-Z~0vYexQ zgCtnR`(tE>GcC80xRwpxDidQJdXIe+rZ_nJ&d67!|5lMR#W5zmPz8mEn zB;kEfEbVw9oi?kh2%K<@5+hrT>_Jl$yGdaM9V*)*go?937}v|V*T=+InHL*c?)Fl0~#Crpqf zjEQ1fTjLVPg4W=7R`ihyC}R=LWFMoI0aR6@$A>K_HE(WWolI6zNSsczYmfkKxYB~l zsG4@GI<2gzpkduKX#s|FjHiAR(L^>jV;L*dPf4L}V@dc9LA>>S(d86Fq0t7$cH(+^ z&SW1*s^fkdpg=RJb#NzU-+pdu5h1%CrHmpw<}kQ z%98~52~aiLbC|c+PC&ADhlimp>lv*#RHOhU0O#gqd?txuZ>#y zBGrHywoEPPxohvLQ&oB(c+^kWn;H~)Z9{|KicrGtCtO*D0R-2VqPT`_ifxf{CL7yp zd-tF;IFClsOplH{HaOsZDRhz&Au|O;Owc ziZMk+BJVihi+)2r9I^;)8d5epYVE@^^KNrz{gF_LY3bTdi8&S^m$;(pjoHrkNwrRE z=_z){bZ;}lF~@o1c7Q;}oZ9;i*~BaUbGLT7T?*Z?tEgp#Z$ZIco_nze(;=_hh2cHW#UB< zj8G5mlvD{)td_KGTZbMbX_pdSl+nXt@=T8M_P&L+nnT%A*%Nh= zM{Rg(qF8e~E!ga@Rbp5Ikrqi1H>veb z2LU@g^+)_CQ~z~?$7E>AUNmRF!*fFS!n%pe@ZMF8OKEtf7|9XG26S<5AUNP@8@N~< z|EINQ?+a^;X|R`f4hw@T2AW#@*TyM!Cf;_-=p`HmQkF}w-x zBv9_J@-&y2IFPHQKAD4mH32`OOK1y2e`v4ND6L*~z|IvEBOi+fP$+Alb*miEvmEgY z;zVxzXSDVUstsjD)d%jU0lWpfVKAFmB2)}&5MJDYi@)ihGiHZ0ygHc>qTpiMVKS{u zco4e|2*KlVz;r&QiV+##9f8rR1UOiLe{nm=(GZX+(FB6#IH>O`^w&W$4_%nnLY4fd zJ`VPuP%?Dkf2BM*%i1(7E(hqQEsHfZfMKvTxi7J4st1M(q!;L(0fGS873$*KXZRD> z?(Uk44~u%vzf-}=2JaT*6$~Jqxn?aejIH?6tqyVWmE|GMg;_>G=q{Fsm%zD5X)wh+ zEq2l($AExoAAu)A6a)?Nq!JlI=S*NpOe;cD+v1t<(F8^ID sn@gL23wM7r$A$tM3T!B_p}>X$8wzYFu%W<)0vif!D6pZxzbFO%54h{BM*si- literal 0 HcmV?d00001 diff --git a/document/setup.js b/document/setup.js new file mode 100644 index 0000000..ca24761 --- /dev/null +++ b/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../"; +document.write(''); +document.write(''); +document.write(''); diff --git a/shared/document/setup.js b/shared/document/setup.js new file mode 100644 index 0000000..bffdab2 --- /dev/null +++ b/shared/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../../"; +document.write(''); +document.write(''); +document.write(''); -- 2.20.1