From c42c6b1c73ed06d7d913b8f1433f7caed8f758d2 Mon Sep 17 00:00:00 2001 From: David Antoon Date: Fri, 30 Jan 2026 08:09:54 +0200 Subject: [PATCH 1/2] refactor: reorganize documentation structure and clarify editing guidelines in .coderabbit.yaml --- .coderabbit.yaml | 81 ++++++++------------------------------- docs/enclave/favicon.ico | Bin 15086 -> 0 bytes 2 files changed, 17 insertions(+), 64 deletions(-) delete mode 100644 docs/enclave/favicon.ico diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 2b9290d..afdc6ba 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -10,85 +10,38 @@ reviews: It can be used as a reference for SDK usage examples. # ───────────────────────────────────────────────────────── - # DOCS HIERARCHY & WORKFLOW + # DOCS # ───────────────────────────────────────────────────────── - # Latest rendered docs for current minor – GENERATED ONLY - - path: "docs/docs/**" + # Human-editable documentation content + - path: "docs/enclave/**" instructions: > - This folder contains the latest Mintlify documentation for the CURRENT minor - version, using SEO-friendly paths (e.g. "docs/getting-started/welcome"). - These files are generated/updated by the Codex GitHub Action, NOT manually. - When reviewing a PR: - - If a contributor edits files under docs/docs/** directly, ask them to revert - those changes and instead update the corresponding draft under docs/draft/docs/**. - - Do NOT suggest manual edits here; suggest editing drafts and letting automation - regenerate docs/docs/**. - - The release process for a new minor is: - 1) Copy the current docs/docs/** into docs/v/{previous-minor}/** to freeze them. - 2) Update docs/docs/** based on docs/draft/docs/** and the code changes. - - # Frozen archived docs for old minors – NEVER EDIT - - path: "docs/v/**" - instructions: > - This folder contains frozen, archived documentation for previous minor versions, - e.g. docs/v/0.1/**, docs/v/0.2/**. - These are historical snapshots and must NEVER be edited. - When reviewing a PR: - - If any file under docs/v/** is modified, treat it as a mistake and ask the author - to revert. Explain that archived docs are read-only. - - If authors want to fix or improve docs, they should work in docs/draft/docs/** - and let the release/automation flow handle new minors. - - # Drafts – THIS is where humans should edit docs - - path: "docs/draft/docs/**" - instructions: > - This folder holds the draft/source docs that humans are expected to edit. - When authors want to add or change documentation, they should do it here. - The Codex workflow uses these drafts, together with the code diff, to generate - the latest docs under docs/docs/**. + This folder contains all the human-editable Mintlify documentation (MDX files). + It includes sections like getting-started, concepts, core-libraries, enclavejs, + guides, examples, troubleshooting, api-reference, and snippets. As a reviewer: - - Encourage contributors to add/update content here instead of docs/docs/**. - - It is fine to do structural/content feedback here (clarity, examples, etc). - - # Blogs – human edited, not touched by Codex - - path: "docs/blogs/**" - instructions: > - This folder contains blog posts (e.g. "docs/blogs/november-2025/..."). - These are NOT managed by the Codex docs automation. - Human-authored changes here are expected and allowed. - As a reviewer, ensure the changes look intentional and not like bulk/automated - rewrites of the entire blog tree. + - Ensure documentation is clear, accurate, and matches the current SDK APIs. + - Check for broken links or references to non-existent pages. + - Verify code examples are correct and follow best practices. # Mintlify navigation config - path: "docs/docs.json" instructions: > Mintlify navigation configuration. - Important structure: + Structure: - dropdowns[].dropdown == "Documentation": - - Contains a "versions" array. - - Latest version entry: "version": "vX.Y (latest)", "default": true, with - paths like "docs/getting-started/welcome" and "updates" (NO "v/X.Y" prefix). - - Older versions: "version": "v0.2", "version": "v0.1", etc., with paths - like "docs/v/0.2/getting-started/welcome". - - dropdowns[].dropdown == "Blog": - - Contains blog groups (e.g. "blog/november-2025/introducing-frontmcp"). + - Contains groups for different documentation sections. + - Paths reference content under docs/enclave/ (e.g. "enclave/getting-started/welcome"). Review guidelines: - - Do NOT suggest editing the Blog dropdown unless the PR explicitly adds/changes blogs. - - Ensure latest version uses non-versioned "docs/..." paths, and older versions - use "docs/v/{minor}/..." paths. - - If you see changes that try to route archived versions away from docs/v/**, - flag that as incorrect. + - Ensure navigation paths match actual files in docs/enclave/. + - Verify group structure is logical and well-organized. # Generic docs catch-all (for anything not covered above) - path: "docs/**" instructions: > Repository documentation for the SDK, using MDX and hosted by Mintlify. See more specific rules for: - - docs/docs/** (latest rendered docs, automation-only) - - docs/v/** (archived versions, read-only) - - docs/draft/docs/** (human-editable drafts) - - docs/blogs/** (blogs, human edited) + - docs/enclave/** (human-editable documentation content) - docs/docs.json (Mintlify navigation) # SDK libs @@ -96,8 +49,8 @@ reviews: instructions: > Contains publishable SDK libraries. Review for API correctness, breaking changes, and consistency with docs. - When public APIs change, ensure there is a matching docs/draft/docs/** update - (not direct edits under docs/docs/**). + When public APIs change, ensure there is a matching documentation update + under docs/enclave/**. path_filters: - "!**/dist/**" diff --git a/docs/enclave/favicon.ico b/docs/enclave/favicon.ico deleted file mode 100644 index f663fae6605baf7734a10f07777122e65682a54a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 15086 zcmdU#y^a(|5XT!~i4YRvy~Gm9osf{6A>V_5BuDgB1V2p+U<55@pJKO@jLNn@n2#i`pB3=2i?svF)jI4 z{D=BfU5z2l;No z4i1mY`p9h`)pU-LgM2panFtq{OBAgWJ{qZMFUc2Yb&+!HjBDqUIa`~&?Z{#AObhtp zJriNCC0xU9xiseRLHb1!hKm{w=GMS&SbKeq*uv+7<~HMevFVK$)!ndLkY1mo-6mfI z$*b=Ky>VKw-ynzA9>4tXE>@&tVz;2eGdth;I+>npr*}Tdig$f4cKr8ZiPj1q3pq^B zHH8fCoI|kp+LW+c4JtVdcagAf#Cz0>0|&h}5q5iK8~%lL*eLAYv$hwUYk2(L*G<~_K^3P$Oc(NQJ&=F2<-f>-j#HbM-<^;uOg3Z zkR4)^uK_Wf|Jiqfl7BlxkuT;-jDC-e>DO$)=*WNL7{s+4N;q#zo?&-sTz9``{BGY| z19sn;YS?XUduv_W3%$P3&(^@ciw$QY_lIt#KjcjvO1KWSiE3Ml<8F_UCjw<*~focZ40tVBgTm zDazqH!w%$))-kDVdVfaMbMN|N+iT<3KCAKcTVC=P+1xbD*TL}j;#e6w`26peRewK5 zIrrvUsk_y7`u(Wdu!m;%kSST4V=DR2^^Q%cRvMA7rl_Fu`y$(z2P+j_{Z_)Kstp>6?9*Lu z_*&YVir(!>X8Y@MqGW@=)me#@fki>d+@dDD%St<|8GS3Q8zK?oEp9p z&%TRkY~Kl(LkHbeYQ5WS@9-}UyMI#pnf7Z+_i3+Ex<|X!{~w|Sxc>Z0`!Xe|%OIt{ zX*Vg!OorF(72|s;UDDpYZnuo@q?EUaZ|fO)@=Spj=v6NU`8yR;&pqOK%yUaVXN;_Z1z)EvIHdPf?ALa}(DE)&d4Iv@(;5cN zlXn=~=S&PAhrILo3G}>!?_wP^7uI~qH}UiJ@c8Bsb|0e}NGIHDy|I_{M=Y~FDcM4`;5TGt|bi|sW3=MZ2mxuz5Ox!W9)B%$G^7~-|FIm@714rgU1+~ydJ$exsNeE^&j@1pU1Z+ zzyA3gdf@c8al`*5*QBla_|?=krP5n>aT*n9V{k4s&T z6r1?Nd#c)L4G=;eLmvNzHUAbsF_qgu5;Q-5SBedW>G=x?jThfPd`&Rv+-t-%n!SGv zMfiqcIE$uaZ65cAvBUQ-Feu)sc)F7l$Hd>7w8M+{G;vxot>5$Ai= z1;=Og{hRm@7{%dQkgKl+>c*AW_^Rej+?-?+?n%i90*kT9f;QZ1d92b{{?5dE_d^gT z7hy9yW2G1^a{01%Mf_4vzengJWA2%_`S3J}tnP`eL!w z=L0x(lG$C#$JOW$-^3smF^SE0iU;BoanE-O<#;N7BmN{dqK~Y)*EIjT8L(&J{7j=G zNP8stpWapqlfCtA9$oK1<5^r{8i4_OWZ5|ya7d4Q2Qs{V>|^`>sAIL7u$F8&PXUgh z&P#F4*6=$V!y1vBF>}V2b2Mhoh`#x>K4bdP*yN-ACy$>#wqS;AY}k=uKaOo*P4(-r z#nrGU=|K3zxAiTjL7+b_u8D^Itij&?X|SE`WBJ(IzZNg|g|1|KQ_tiJlZNqJZ4!YQ2`yXo^4Ltw= From 14ec0f3d1bd6fc223781aff329c3f0425cef9974 Mon Sep 17 00:00:00 2001 From: David Antoon Date: Fri, 30 Jan 2026 08:13:24 +0200 Subject: [PATCH 2/2] refactor: update base branches in documentation for review profiles --- .coderabbit.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index afdc6ba..2801f1a 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -2,6 +2,9 @@ reviews: profile: chill high_level_summary: true + base_branches: + - main + - release/* path_instructions: - path: "apps/demo/**"