From 9a2ae93ccf4d7bd3eb9139d615d20a7aa376f0ca Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Sun, 11 Jan 2026 09:50:36 +0000 Subject: [PATCH] wip: anchor links on every spec clause --- docs/404.html | 2 +- docs/_astro/index.Dj4jDMY1.css | 1 + docs/_astro/index.Ds9Y8AeZ.css | 1 - docs/index.html | 140 ++++++++++++++++---------------- docs/spec/1.0.0-rc.1/index.html | 88 ++++++++++---------- docs/spec/1.0.0-rc.2/index.html | 114 +++++++++++++------------- docs/spec/1.0.0-rc.3/index.html | 120 +++++++++++++-------------- docs/spec/1.0.0-rc.4/index.html | 140 ++++++++++++++++---------------- docs/spec/1.0.0-rc.5/index.html | 140 ++++++++++++++++---------------- src/styles/global.css | 53 ++++++++++-- src/utils/parseSpecContent.ts | 65 +++++++++------ 11 files changed, 463 insertions(+), 401 deletions(-) create mode 100644 docs/_astro/index.Dj4jDMY1.css delete mode 100644 docs/_astro/index.Ds9Y8AeZ.css diff --git a/docs/404.html b/docs/404.html index 8b67a88..ff98aeb 100644 --- a/docs/404.html +++ b/docs/404.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

404

diff --git a/docs/_astro/index.Dj4jDMY1.css b/docs/_astro/index.Dj4jDMY1.css new file mode 100644 index 0000000..5c472eb --- /dev/null +++ b/docs/_astro/index.Dj4jDMY1.css @@ -0,0 +1 @@ +@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-vietnamese-wght-normal.BUzh504Q.woff2) format("woff2-variations");unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB}@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-latin-ext-wght-normal.CcLUaPy7.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-latin-wght-normal.DLoelf7F.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}@font-face{font-family:DM Sans Variable;font-style:normal;font-display:swap;font-weight:100 1000;src:url(/_astro/dm-sans-latin-ext-wght-normal.BOFOeGcA.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:DM Sans Variable;font-style:normal;font-display:swap;font-weight:100 1000;src:url(/_astro/dm-sans-latin-wght-normal.Xz1IZZA0.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(data:font/woff2;base64,d09GMgABAAAAAAfsABQAAAAAEAwAAAeCAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGhwbHhwoP0hWQVJbBmA/U1RBVIFiJyYAdC9qEQgKhGSEAAsgADCGCAE2AiQDOgQgBYlMB4EUDAcbLQ4onoexrSC/2ZyLAa8p8VHB8/x3Vue+V0hVJalMJg2nx/TCrQXxBeqLjQG7FyM1WEa/X1tEXN7cFz9EJEMmMUz3RihWSSKeQCbcIou0izz/C8v+fq3VfajEa9gDD11CImXS7qL/RJFVzC1qiB6KmKeD6TZdQ6IRGv78dL6uSVVCfgni5mzu7kcgQBgAEAQTQRCoL++STTYybkJxNfQxAAIAGu8OdEB9teW2jh4BpgDqFjAeSEByW3zFP0CBBgNMsMCGEDjgggdhiEAUAeIIED7ABTDUEnkIE9Q9ahFgKttcVhApo4ACB4qobHaccgDfEjFO6aaWUhjMLt2SyIvHKoDqoA4CSUwEIYQCEjhAO9R1G6keDeDZGjNo+AhxOjCEGTr1WeIF3kYBiLAOKvkJSMiKX0VdAyQt3SDJClCkxJCHkCzfqyVTriJZLcolS32JZHUekq2TYNkYtCtjYHMQXSxGjXDz2t/yLWXzDzxz+o3zFwDEaN23F+13pyMdQAEaSKAR9vcGq4A4MTSKCElGW+M7UcY7xqkggITb28ZJhlqc9q2twYKTt0NjixBgYvO9BIihEBLYuOFXQzfIQ7dXGUEEEgFDooBfAzqiQbpJrhiWSuKJCRFKYbHCyJKI2G5GiZbNAvgAu5pc3vwx4G+g3aDkhklABiSz0BICXrYghtYhx/cdJ+44rY2oZ0aMNRFz3VZjb6W33F3gzltqtOCV8tTHSpOeXuItfvr5lCdfzFpqtEitvqdcdGGFd28ZqqC0tPbeChGXgrIlnhSWu/eUso4uKWFLugyDzQJhflY4659+WjQ++6x72WUMv9G8mw6QJl7BVxX5fe/kpUsOvnZwee9uQ0cGXYd0o89XB2748sDSnt8d2VphdOTTgceDVvOds0v9P/s7HPq15aGun/6Vllb56f1dl0t1LejqrNkpdRZsG8TOnM5vkBG5oiVyVGnS8LHps5cfNWJs6qKPfaNSxiQNBUm3cKNWROr0GSur7Za31k1vieq7LH11VF+jXdRIasRKflc7jkobm1Z9te1IyZA0pDkhLR98+H37Zf1c/8at+dB7x+7GfVyTfJMPiYztsnl59Y5l4j+0n1RXlpHnF3Tq7HecmNF/CJodEMAikruxiyJaGLvHOdAfoA+oDvpjBm2b91cHGRZMU9n25xEU0A8fgEEAdKI3Q1iDtc034sug5YVMkE2jsE+BIkwSoQ3gxXMqz9tELp48bd0cFKOKS7xYjEuXBnZP5ia7DyiO/X/YI+PQSbt2uSdqAkWL9nQbV1XB94/+uPfdZz8dnXYFBYrcTl2SIR/ybxJNJPz/Gupb0JaZeens2ekC7EKr8t+Ls/P5VJPYJdHKyqfg2nqU6bhlidzcddQV/7MmecTzJ5VPcKXkNKSEogHjYFx6QZ7rQ+FSe8njaiNuOnXS8H2ScQ619c2mC3VTtauL0rRbXd/CkSOP37FY9Zkjz8+GibYUMOEWF+RdrFS8Ecv1SHOpPUPZGEIpjPvFyU5cXKjd6OXqorTqy9GwRd++HVufPGnVsW+aO3vggKZ18jR9sXaTC1PWTEsVUaK0FkNySbTQDqlm2PfDjZcu4aalnSLKjnOoYQ0nUlqqXcGpPu/4VgV/xU2pAqW4BW3qzhQ8/hFKhV2qE3+BKAtDqBXjfgnVdH4y0wg5tbVNRenNdTWOrenWLcupQdmsbq5b+18piTe/xRdp1xbILxNPJGInm2z6hoB21Lal0i+ePTtd7B45+3XhFJ329evskXm7qurUVREotqSluSo/L29d3qDhI4YOQqWhI4YNvBNfsMHeXKemXrxQfKeuPOGRVayA3JtkJKEgbPp+dXUDluddutRYLFoXGXWX6N3WFaGLbQtRSitVYNacTNSdy7AaG/HSaUEANcBoGXNdcZvZsOqQ1icBDv21/gzAoYPHH/WDW0qNR3QTYKEAEHig6o13NXbND06CQPlRtYjGNnSktRc09k1mAMDvAlDKfQjgy6fssInlfzmNAjKkDxoxHOBLdVRAIVt9j4qo+hA1w9T1aNBNTUOTTNUHLbqokE+UAfJXCIGw/IxCSL5GRUJeR40rL/UxTm4Q08H6MbCs70ObuNyIIXrINHQYInF06UUlevTjbQzTh5upiDMzMMogUtEnjPs/Y7jAHCJeB0GBHh04tC6FiB6ZFB1oArUSIoFoqhzCeAN6lHwm0T4C3VVPWvjpSMXReuWesMEcoqrmgtNBGd2noWeV0hNAz9rFeShNJxHGsPa3HXeKTk8b55hahySYHaYKKFFLpCfN8rsoaJn01CR04Gkc+5k7KVTCmClX8Q10HCrUEkVlSX+XO33oQR9609tJ516H497WSobWs5Up6TLaS10/dessIskgJSLiDlWvHVUywpkQ7hdPZqGyiEF0uVQerVcPamT1A3eKXdyI1vG9OoflrSXihZ1qqGE3nhmAgiIbRCQgPLEPtOM3UQwTLYaYYomNlpA44opnjV6jkD6id80OOrzf6BzmMD6eEa1zKyeYG1fzfEf16V6jw9XYOaar1/b2kP/IYX8oR2mcFvv2GtBV3JXgd437AQAA) format("woff2-variations");unicode-range:U+0460-052F,U+1C80-1C8A,U+20B4,U+2DE0-2DFF,U+A640-A69F,U+FE2E-FE2F}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-cyrillic-wght-normal.D73BlboJ.woff2) format("woff2-variations");unicode-range:U+0301,U+0400-045F,U+0490-0491,U+04B0-04B1,U+2116}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-greek-wght-normal.Bw9x6K1M.woff2) format("woff2-variations");unicode-range:U+0370-0377,U+037A-037F,U+0384-038A,U+038C,U+038E-03A1,U+03A3-03FF}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-vietnamese-wght-normal.Bt-aOZkq.woff2) format("woff2-variations");unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-latin-ext-wght-normal.DBQx-q_a.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-latin-wght-normal.B9CIFXIH.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}/*! tailwindcss v4.1.18 | MIT License | https://tailwindcss.com */@layer properties{@supports (((-webkit-hyphens:none)) and (not (margin-trim:inline))) or ((-moz-orient:inline) and (not (color:rgb(from red r g b)))){*,:before,:after,::backdrop{--tw-translate-x:0;--tw-translate-y:0;--tw-translate-z:0;--tw-rotate-x:initial;--tw-rotate-y:initial;--tw-rotate-z:initial;--tw-skew-x:initial;--tw-skew-y:initial;--tw-space-y-reverse:0;--tw-border-style:solid;--tw-gradient-position:initial;--tw-gradient-from:#0000;--tw-gradient-via:#0000;--tw-gradient-to:#0000;--tw-gradient-stops:initial;--tw-gradient-via-stops:initial;--tw-gradient-from-position:0%;--tw-gradient-via-position:50%;--tw-gradient-to-position:100%;--tw-leading:initial;--tw-font-weight:initial;--tw-tracking:initial;--tw-shadow:0 0 #0000;--tw-shadow-color:initial;--tw-shadow-alpha:100%;--tw-inset-shadow:0 0 #0000;--tw-inset-shadow-color:initial;--tw-inset-shadow-alpha:100%;--tw-ring-color:initial;--tw-ring-shadow:0 0 #0000;--tw-inset-ring-color:initial;--tw-inset-ring-shadow:0 0 #0000;--tw-ring-inset:initial;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-offset-shadow:0 0 #0000;--tw-blur:initial;--tw-brightness:initial;--tw-contrast:initial;--tw-grayscale:initial;--tw-hue-rotate:initial;--tw-invert:initial;--tw-opacity:initial;--tw-saturate:initial;--tw-sepia:initial;--tw-drop-shadow:initial;--tw-drop-shadow-color:initial;--tw-drop-shadow-alpha:100%;--tw-drop-shadow-size:initial;--tw-backdrop-blur:initial;--tw-backdrop-brightness:initial;--tw-backdrop-contrast:initial;--tw-backdrop-grayscale:initial;--tw-backdrop-hue-rotate:initial;--tw-backdrop-invert:initial;--tw-backdrop-opacity:initial;--tw-backdrop-saturate:initial;--tw-backdrop-sepia:initial;--tw-duration:initial;--tw-ease:initial}}}@layer theme{:root,:host{--font-sans:"DM Sans Variable",system-ui,sans-serif;--font-mono:"JetBrains Mono Variable","SF Mono",Consolas,monospace;--color-sky-400:oklch(74.6% .16 232.661);--color-sky-500:oklch(68.5% .169 237.323);--color-sky-600:oklch(58.8% .158 241.966);--color-gray-50:oklch(98.5% .002 247.839);--color-gray-100:oklch(96.7% .003 264.542);--color-gray-200:oklch(92.8% .006 264.531);--color-gray-300:oklch(87.2% .01 258.338);--color-gray-400:oklch(70.7% .022 261.325);--color-gray-500:oklch(55.1% .027 264.364);--color-gray-600:oklch(44.6% .03 256.802);--color-gray-900:oklch(21% .034 264.665);--color-gray-950:oklch(13% .028 261.692);--color-neutral-50:oklch(98.5% 0 0);--color-neutral-400:oklch(70.8% 0 0);--color-neutral-500:oklch(55.6% 0 0);--color-neutral-600:oklch(43.9% 0 0);--color-neutral-700:oklch(37.1% 0 0);--color-neutral-800:oklch(26.9% 0 0);--color-neutral-900:oklch(20.5% 0 0);--color-neutral-950:oklch(14.5% 0 0);--color-black:#000;--color-white:#fff;--spacing:.25rem;--container-2xl:42rem;--container-3xl:48rem;--container-4xl:56rem;--container-6xl:72rem;--text-xs:.75rem;--text-xs--line-height:calc(1/.75);--text-sm:.875rem;--text-sm--line-height:calc(1.25/.875);--text-base:1rem;--text-base--line-height: 1.5 ;--text-lg:1.125rem;--text-lg--line-height:calc(1.75/1.125);--text-xl:1.25rem;--text-xl--line-height:calc(1.75/1.25);--text-3xl:1.875rem;--text-3xl--line-height: 1.2 ;--text-4xl:2.25rem;--text-4xl--line-height:calc(2.5/2.25);--font-weight-medium:500;--font-weight-semibold:600;--font-weight-bold:700;--tracking-tight:-.025em;--tracking-wider:.05em;--radius-md:.375rem;--radius-lg:.5rem;--radius-2xl:1rem;--ease-out:cubic-bezier(0,0,.2,1);--blur-xl:24px;--default-transition-duration:.15s;--default-transition-timing-function:cubic-bezier(.4,0,.2,1);--default-font-family:var(--font-sans);--default-mono-font-family:var(--font-mono);--color-accent:oklch(68.5% .169 237.323);--color-accent-light:oklch(74.6% .16 232.661);--font-display:"Bricolage Grotesque Variable",system-ui,sans-serif;--header-height:4rem;--sidebar-width:260px;--content-max-width:800px;--section-padding-x:2rem;--transition-fast:.15s cubic-bezier(.4,0,.2,1)}}@layer base{*,:after,:before,::backdrop{box-sizing:border-box;border:0 solid;margin:0;padding:0}::file-selector-button{box-sizing:border-box;border:0 solid;margin:0;padding:0}html,:host{-webkit-text-size-adjust:100%;tab-size:4;line-height:1.5;font-family:var(--default-font-family,ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji");font-feature-settings:var(--default-font-feature-settings,normal);font-variation-settings:var(--default-font-variation-settings,normal);-webkit-tap-highlight-color:transparent}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;-webkit-text-decoration:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:var(--default-mono-font-family,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace);font-feature-settings:var(--default-mono-font-feature-settings,normal);font-variation-settings:var(--default-mono-font-variation-settings,normal);font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}:-moz-focusring{outline:auto}progress{vertical-align:baseline}summary{display:list-item}ol,ul,menu{list-style:none}img,svg,video,canvas,audio,iframe,embed,object{vertical-align:middle;display:block}img,video{max-width:100%;height:auto}button,input,select,optgroup,textarea{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}::file-selector-button{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}:where(select:is([multiple],[size])) optgroup{font-weight:bolder}:where(select:is([multiple],[size])) optgroup option{padding-inline-start:20px}::file-selector-button{margin-inline-end:4px}::placeholder{opacity:1}@supports (not ((-webkit-appearance:-apple-pay-button))) or (contain-intrinsic-size:1px){::placeholder{color:currentColor}@supports (color:color-mix(in lab,red,red)){::placeholder{color:color-mix(in oklab,currentcolor 50%,transparent)}}}textarea{resize:vertical}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-date-and-time-value{min-height:1lh;text-align:inherit}::-webkit-datetime-edit{display:inline-flex}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-datetime-edit{padding-block:0}::-webkit-datetime-edit-year-field{padding-block:0}::-webkit-datetime-edit-month-field{padding-block:0}::-webkit-datetime-edit-day-field{padding-block:0}::-webkit-datetime-edit-hour-field{padding-block:0}::-webkit-datetime-edit-minute-field{padding-block:0}::-webkit-datetime-edit-second-field{padding-block:0}::-webkit-datetime-edit-millisecond-field{padding-block:0}::-webkit-datetime-edit-meridiem-field{padding-block:0}::-webkit-calendar-picker-indicator{line-height:1}:-moz-ui-invalid{box-shadow:none}button,input:where([type=button],[type=reset],[type=submit]){appearance:button}::file-selector-button{appearance:button}::-webkit-inner-spin-button{height:auto}::-webkit-outer-spin-button{height:auto}[hidden]:where(:not([hidden=until-found])){display:none!important}html{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;height:100%}body{font-family:var(--font-sans);color:#020618;background-color:#f8fafc;font-size:16px;font-weight:400;line-height:1.7;overflow-x:hidden}.dark body{color:#fafafa;background-color:#0a0a0a}h1,h2,h3,h4,h5,h6{font-family:var(--font-display);letter-spacing:-.02em;color:#020618;font-weight:700;line-height:1.2}.dark h1,.dark h2,.dark h3,.dark h4,.dark h5,.dark h6{color:#fafafa}h1{letter-spacing:-.03em;font-size:clamp(2.5rem,6vw,4.5rem);font-weight:800}h2{margin-top:3rem;margin-bottom:1.5rem;font-size:clamp(1.75rem,4vw,2.5rem)}h3{margin-top:2rem;margin-bottom:1rem;font-size:clamp(1.25rem,2vw,1.5rem)}p{margin-bottom:1.25rem}a{color:var(--color-accent);transition:color var(--transition-fast);word-break:break-word;text-decoration:none}a:hover{color:var(--color-accent-light)}code{font-family:var(--font-mono);background-color:#0206180d;border-radius:4px;padding:.2em .4em;font-size:.875em}.dark code{background-color:#a1a1a126}pre{font-family:var(--font-mono);background-color:#e2e8f0;border-radius:8px;padding:1.25rem;line-height:1.6;overflow-x:auto}.dark pre{background-color:#171717}pre>code{padding:0;font-size:.875rem;background-color:#0000!important}ul,ol{margin-bottom:1.25rem;padding-left:1.5rem}ul{list-style-type:disc}ol{list-style-type:decimal}li{margin-bottom:.5rem}ol ol,ul ol,ul ul ol,ul ol ol,ol ul ol,ol ol ol{list-style-type:decimal}blockquote{border-left:3px solid var(--color-accent);color:#45556c;margin:1.5rem 0;padding-left:1.5rem;font-style:italic}.dark blockquote{color:#a1a1a1}strong{font-weight:600}:focus-visible{outline:2px solid var(--color-accent);outline-offset:2px}}@layer components{.section-container{max-width:calc(var(--content-max-width) + var(--sidebar-width) + 4rem);padding:0 var(--section-padding-x);margin:0 auto}.prose-spec{max-width:var(--content-max-width)}.prose-spec h2{border-bottom:1px solid oklch(92.9% .013 255.508);margin-top:3rem;margin-bottom:1.5rem;padding-bottom:.75rem;font-size:1.75rem}.dark .prose-spec h2{border-bottom-color:#262626}.prose-spec h2:first-child{margin-top:0}.prose-spec h3{color:#45556c;margin-top:2rem;margin-bottom:1rem;font-size:1.25rem;font-weight:600}.dark .prose-spec h3{color:#a1a1a1}.prose-spec p{color:#45556c}.dark .prose-spec p{color:#a1a1a1}.prose-spec strong{color:#020618}.dark .prose-spec strong{color:#fafafa}.prose-spec li{color:#45556c}.dark .prose-spec li{color:#a1a1a1}.prose-spec ol{counter-reset:item;padding-left:2.5rem;list-style:none}.prose-spec ol>li{counter-increment:item;margin-bottom:.5rem;position:relative}.prose-spec ol>li:before{content:counters(item,".")".";text-align:right;color:#90a1b9;width:2rem;font-weight:500;position:absolute;left:-2.5rem}.dark .prose-spec ol>li:before{color:#737373}.prose-spec .clause-link{opacity:0;justify-content:center;align-items:center;width:1.25rem;height:1.25rem;text-decoration:none;transition:opacity .15s;display:flex;position:absolute;top:.125rem;left:-3.5rem}.prose-spec .clause-link:before{content:"";background-image:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%2394a3b8'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E");background-repeat:no-repeat;background-size:contain;width:1rem;height:1rem;display:block}.dark .prose-spec .clause-link:before{background-image:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%23737373'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E")}.prose-spec ol>li:hover:not(:has(ol:hover))>.clause-link,.prose-spec ol>li:hover:not(:has(ol:hover))>p>.clause-link,.prose-spec .clause-link:hover{opacity:1}.prose-spec .clause-link:hover:before{background-image:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%23f97316'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E")}.prose-spec img{border-radius:8px;max-width:100%;height:auto;margin:2rem 0}.prose-spec p:last-child{margin-bottom:0}.nav-link.active{color:oklch(50% .134 242.749)!important;background-color:oklab(58.8% -.0742593 -.139462/.15)!important}.dark .nav-link.active{color:oklch(74.6% .16 232.661)!important;background-color:oklab(58.8% -.0742593 -.139462/.2)!important}.sidebar-link.active{color:oklch(50% .134 242.749)!important;background-color:oklab(58.8% -.0742593 -.139462/.15)!important}.dark .sidebar-link.active{color:oklch(74.6% .16 232.661)!important;background-color:oklab(58.8% -.0742593 -.139462/.2)!important}#spec-sidebar::-webkit-scrollbar{width:4px}#spec-sidebar::-webkit-scrollbar-track{background:0 0}#spec-sidebar::-webkit-scrollbar-thumb{background-color:#e2e8f0;border-radius:2px}.dark #spec-sidebar::-webkit-scrollbar-thumb{background-color:#262626}}@layer utilities{.pointer-events-none{pointer-events:none}.invisible{visibility:hidden}.visible{visibility:visible}.absolute{position:absolute}.fixed{position:fixed}.relative{position:relative}.static{position:static}.inset-0{inset:calc(var(--spacing)*0)}.inset-x-0{inset-inline:calc(var(--spacing)*0)}.top-0{top:calc(var(--spacing)*0)}.top-full{top:100%}.right-6{right:calc(var(--spacing)*6)}.bottom-0{bottom:calc(var(--spacing)*0)}.bottom-6{bottom:calc(var(--spacing)*6)}.bottom-8{bottom:calc(var(--spacing)*8)}.left-0{left:calc(var(--spacing)*0)}.left-1\/2{left:50%}.z-10{z-index:10}.z-20{z-index:20}.z-40{z-index:40}.z-50{z-index:50}.mx-auto{margin-inline:auto}.my-28{margin-block:calc(var(--spacing)*28)}.mt-2{margin-top:calc(var(--spacing)*2)}.mt-8{margin-top:calc(var(--spacing)*8)}.mb-2{margin-bottom:calc(var(--spacing)*2)}.mb-3{margin-bottom:calc(var(--spacing)*3)}.mb-4{margin-bottom:calc(var(--spacing)*4)}.mb-6{margin-bottom:calc(var(--spacing)*6)}.mb-8{margin-bottom:calc(var(--spacing)*8)}.mb-10{margin-bottom:calc(var(--spacing)*10)}.mb-12{margin-bottom:calc(var(--spacing)*12)}.mb-16{margin-bottom:calc(var(--spacing)*16)}.block{display:block}.contents{display:contents}.flex{display:flex}.grid{display:grid}.hidden{display:none}.inline{display:inline}.inline-flex{display:inline-flex}.table{display:table}.h-3\.5{height:calc(var(--spacing)*3.5)}.h-4{height:calc(var(--spacing)*4)}.h-5{height:calc(var(--spacing)*5)}.h-6{height:calc(var(--spacing)*6)}.h-12{height:calc(var(--spacing)*12)}.h-16{height:calc(var(--spacing)*16)}.h-auto{height:auto}.max-h-\[70vh\]{max-height:70vh}.min-h-\[75vh\]{min-height:75vh}.min-h-screen{min-height:100vh}.w-3\.5{width:calc(var(--spacing)*3.5)}.w-4{width:calc(var(--spacing)*4)}.w-5{width:calc(var(--spacing)*5)}.w-6{width:calc(var(--spacing)*6)}.w-12{width:calc(var(--spacing)*12)}.w-full{width:100%}.max-w-2xl{max-width:var(--container-2xl)}.max-w-3xl{max-width:var(--container-3xl)}.max-w-4xl{max-width:var(--container-4xl)}.max-w-6xl{max-width:var(--container-6xl)}.min-w-0{min-width:calc(var(--spacing)*0)}.min-w-full{min-width:100%}.flex-1{flex:1}.flex-shrink-0,.shrink-0{flex-shrink:0}.-translate-x-1\/2{--tw-translate-x: -50% ;translate:var(--tw-translate-x)var(--tw-translate-y)}.-translate-y-1{--tw-translate-y:calc(var(--spacing)*-1);translate:var(--tw-translate-x)var(--tw-translate-y)}.translate-y-\[-100\%\]{--tw-translate-y:-100%;translate:var(--tw-translate-x)var(--tw-translate-y)}.rotate-180{rotate:180deg}.transform{transform:var(--tw-rotate-x,)var(--tw-rotate-y,)var(--tw-rotate-z,)var(--tw-skew-x,)var(--tw-skew-y,)}.cursor-pointer{cursor:pointer}.grid-rows-\[0fr\]{grid-template-rows:0fr}.grid-rows-\[1fr\]{grid-template-rows:1fr}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.items-center{align-items:center}.justify-between{justify-content:space-between}.justify-center{justify-content:center}.gap-1{gap:calc(var(--spacing)*1)}.gap-1\.5{gap:calc(var(--spacing)*1.5)}.gap-2{gap:calc(var(--spacing)*2)}.gap-3{gap:calc(var(--spacing)*3)}.gap-4{gap:calc(var(--spacing)*4)}.gap-8{gap:calc(var(--spacing)*8)}:where(.space-y-0>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*0)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*0)*calc(1 - var(--tw-space-y-reverse)))}:where(.space-y-1>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*1)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*1)*calc(1 - var(--tw-space-y-reverse)))}.overflow-hidden{overflow:hidden}.overflow-y-auto{overflow-y:auto}.rounded{border-radius:.25rem}.rounded-2xl{border-radius:var(--radius-2xl)}.rounded-full{border-radius:3.40282e38px}.rounded-lg{border-radius:var(--radius-lg)}.rounded-md{border-radius:var(--radius-md)}.rounded-t-2xl{border-top-left-radius:var(--radius-2xl);border-top-right-radius:var(--radius-2xl)}.border{border-style:var(--tw-border-style);border-width:1px}.border-t{border-top-style:var(--tw-border-style);border-top-width:1px}.border-b{border-bottom-style:var(--tw-border-style);border-bottom-width:1px}.border-gray-200{border-color:var(--color-gray-200)}.border-transparent{border-color:#0000}.bg-black\/50{background-color:#00000080}@supports (color:color-mix(in lab,red,red)){.bg-black\/50{background-color:color-mix(in oklab,var(--color-black)50%,transparent)}}.bg-gray-50{background-color:var(--color-gray-50)}.bg-gray-50\/85{background-color:#f9fafbd9}@supports (color:color-mix(in lab,red,red)){.bg-gray-50\/85{background-color:color-mix(in oklab,var(--color-gray-50)85%,transparent)}}.bg-gray-100{background-color:var(--color-gray-100)}.bg-gray-900{background-color:var(--color-gray-900)}.bg-sky-500\/15{background-color:#00a5ef26}@supports (color:color-mix(in lab,red,red)){.bg-sky-500\/15{background-color:color-mix(in oklab,var(--color-sky-500)15%,transparent)}}.bg-sky-600{background-color:var(--color-sky-600)}.bg-transparent{background-color:#0000}.bg-white{background-color:var(--color-white)}.bg-gradient-to-b{--tw-gradient-position:to bottom in oklab;background-image:linear-gradient(var(--tw-gradient-stops))}.bg-\[linear-gradient\(theme\(colors\.gray\.950\)_1px\,transparent_1px\)\,linear-gradient\(90deg\,theme\(colors\.gray\.950\)_1px\,transparent_1px\)\]{background-image:linear-gradient(#030712 1px,#0000 1px),linear-gradient(90deg,#030712 1px,#0000 1px)}.from-gray-100{--tw-gradient-from:var(--color-gray-100);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.to-gray-50{--tw-gradient-to:var(--color-gray-50);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.\[mask-image\:linear-gradient\(to_bottom\,black_20\%\,transparent_80\%\)\]{-webkit-mask-image:linear-gradient(#000 20%,#0000 80%);mask-image:linear-gradient(#000 20%,#0000 80%)}.bg-\[size\:60px_60px\]{background-size:60px 60px}.bg-center{background-position:50%}.p-1\.5{padding:calc(var(--spacing)*1.5)}.p-2{padding:calc(var(--spacing)*2)}.p-4{padding:calc(var(--spacing)*4)}.p-6{padding:calc(var(--spacing)*6)}.p-8{padding:calc(var(--spacing)*8)}.px-2{padding-inline:calc(var(--spacing)*2)}.px-2\.5{padding-inline:calc(var(--spacing)*2.5)}.px-3{padding-inline:calc(var(--spacing)*3)}.px-4{padding-inline:calc(var(--spacing)*4)}.px-5{padding-inline:calc(var(--spacing)*5)}.px-6{padding-inline:calc(var(--spacing)*6)}.py-1{padding-block:calc(var(--spacing)*1)}.py-1\.5{padding-block:calc(var(--spacing)*1.5)}.py-2{padding-block:calc(var(--spacing)*2)}.py-2\.5{padding-block:calc(var(--spacing)*2.5)}.py-3{padding-block:calc(var(--spacing)*3)}.py-4{padding-block:calc(var(--spacing)*4)}.py-6{padding-block:calc(var(--spacing)*6)}.py-20{padding-block:calc(var(--spacing)*20)}.pt-8{padding-top:calc(var(--spacing)*8)}.pt-12{padding-top:calc(var(--spacing)*12)}.pt-16{padding-top:calc(var(--spacing)*16)}.pr-4{padding-right:calc(var(--spacing)*4)}.pb-6{padding-bottom:calc(var(--spacing)*6)}.pb-24{padding-bottom:calc(var(--spacing)*24)}.pl-6{padding-left:calc(var(--spacing)*6)}.text-center{text-align:center}.text-left{text-align:left}.font-display{font-family:var(--font-display)}.font-mono{font-family:var(--font-mono)}.text-3xl{font-size:var(--text-3xl);line-height:var(--tw-leading,var(--text-3xl--line-height))}.text-base{font-size:var(--text-base);line-height:var(--tw-leading,var(--text-base--line-height))}.text-lg{font-size:var(--text-lg);line-height:var(--tw-leading,var(--text-lg--line-height))}.text-sm{font-size:var(--text-sm);line-height:var(--tw-leading,var(--text-sm--line-height))}.text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.text-xs{font-size:var(--text-xs);line-height:var(--tw-leading,var(--text-xs--line-height))}.text-\[0\.8125rem\]{font-size:.8125rem}.text-\[8rem\]{font-size:8rem}.leading-none{--tw-leading:1;line-height:1}.font-bold{--tw-font-weight:var(--font-weight-bold);font-weight:var(--font-weight-bold)}.font-medium{--tw-font-weight:var(--font-weight-medium);font-weight:var(--font-weight-medium)}.font-semibold{--tw-font-weight:var(--font-weight-semibold);font-weight:var(--font-weight-semibold)}.tracking-tight{--tw-tracking:var(--tracking-tight);letter-spacing:var(--tracking-tight)}.tracking-wider{--tw-tracking:var(--tracking-wider);letter-spacing:var(--tracking-wider)}.whitespace-nowrap{white-space:nowrap}.text-gray-300{color:var(--color-gray-300)}.text-gray-400{color:var(--color-gray-400)}.text-gray-500{color:var(--color-gray-500)}.text-gray-600{color:var(--color-gray-600)}.text-gray-950{color:var(--color-gray-950)}.text-sky-600{color:var(--color-sky-600)}.text-white{color:var(--color-white)}.uppercase{text-transform:uppercase}.no-underline{text-decoration-line:none}.opacity-0{opacity:0}.opacity-\[0\.06\]{opacity:.06}.shadow-lg{--tw-shadow:0 8px 30px var(--tw-shadow-color,#0000001f);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.shadow-sm{--tw-shadow:0 1px 2px var(--tw-shadow-color,#0000000d);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.shadow-xl{--tw-shadow:0 20px 25px -5px var(--tw-shadow-color,#0000001a),0 8px 10px -6px var(--tw-shadow-color,#0000001a);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.filter{filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.backdrop-blur-xl{--tw-backdrop-blur:blur(var(--blur-xl));-webkit-backdrop-filter:var(--tw-backdrop-blur,)var(--tw-backdrop-brightness,)var(--tw-backdrop-contrast,)var(--tw-backdrop-grayscale,)var(--tw-backdrop-hue-rotate,)var(--tw-backdrop-invert,)var(--tw-backdrop-opacity,)var(--tw-backdrop-saturate,)var(--tw-backdrop-sepia,);backdrop-filter:var(--tw-backdrop-blur,)var(--tw-backdrop-brightness,)var(--tw-backdrop-contrast,)var(--tw-backdrop-grayscale,)var(--tw-backdrop-hue-rotate,)var(--tw-backdrop-invert,)var(--tw-backdrop-opacity,)var(--tw-backdrop-saturate,)var(--tw-backdrop-sepia,)}.transition-\[grid-template-rows\]{transition-property:grid-template-rows;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-all{transition-property:all;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-colors{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-opacity{transition-property:opacity;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-transform{transition-property:transform,translate,scale,rotate;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.delay-100{transition-delay:.1s}.delay-200{transition-delay:.2s}.delay-300{transition-delay:.3s}.delay-400{transition-delay:.4s}.delay-700{transition-delay:.7s}.duration-150{--tw-duration:.15s;transition-duration:.15s}.duration-200{--tw-duration:.2s;transition-duration:.2s}.duration-300{--tw-duration:.3s;transition-duration:.3s}.ease-out{--tw-ease:var(--ease-out);transition-timing-function:var(--ease-out)}.\[-webkit-mask-image\:linear-gradient\(to_bottom\,black_20\%\,transparent_80\%\)\]{-webkit-mask-image:linear-gradient(#000 20%,#0000 80%)}@media(hover:hover){.group-hover\:opacity-100:is(:where(.group):hover *){opacity:1}.hover\:-translate-y-0\.5:hover{--tw-translate-y:calc(var(--spacing)*-.5);translate:var(--tw-translate-x)var(--tw-translate-y)}.hover\:border-sky-600:hover{border-color:var(--color-sky-600)}.hover\:bg-gray-100:hover{background-color:var(--color-gray-100)}.hover\:bg-sky-500:hover{background-color:var(--color-sky-500)}.hover\:bg-white\/50:hover{background-color:#ffffff80}@supports (color:color-mix(in lab,red,red)){.hover\:bg-white\/50:hover{background-color:color-mix(in oklab,var(--color-white)50%,transparent)}}.hover\:text-gray-950:hover{color:var(--color-gray-950)}.hover\:text-sky-400:hover{color:var(--color-sky-400)}.hover\:text-sky-600:hover{color:var(--color-sky-600)}.hover\:shadow-md:hover{--tw-shadow:0 4px 12px var(--tw-shadow-color,#00000014);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}}.data-\[open\]\:visible[data-open]{visibility:visible}.data-\[open\]\:translate-y-0[data-open]{--tw-translate-y:calc(var(--spacing)*0);translate:var(--tw-translate-x)var(--tw-translate-y)}.data-\[open\]\:opacity-100[data-open]{opacity:1}@media(min-width:40rem){.sm\:grid-cols-2{grid-template-columns:repeat(2,minmax(0,1fr))}.sm\:flex-row{flex-direction:row}.sm\:items-center{align-items:center}.sm\:justify-between{justify-content:space-between}.sm\:p-8{padding:calc(var(--spacing)*8)}.sm\:px-6{padding-inline:calc(var(--spacing)*6)}.sm\:py-28{padding-block:calc(var(--spacing)*28)}.sm\:text-4xl{font-size:var(--text-4xl);line-height:var(--tw-leading,var(--text-4xl--line-height))}.sm\:text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.sm\:text-\[12rem\]{font-size:12rem}}@media(min-width:48rem){.md\:block{display:block}.md\:flex{display:flex}.md\:hidden{display:none}}@media(min-width:64rem){.lg\:sticky{position:sticky}.lg\:top-24{top:calc(var(--spacing)*24)}.lg\:mr-8{margin-right:calc(var(--spacing)*8)}.lg\:block{display:block}.lg\:flex{display:flex}.lg\:hidden{display:none}.lg\:max-h-\[calc\(100vh-8rem\)\]{max-height:calc(100vh - 8rem)}.lg\:w-64{width:calc(var(--spacing)*64)}.lg\:flex-shrink-0{flex-shrink:0}.lg\:gap-8{gap:calc(var(--spacing)*8)}.lg\:self-start{align-self:flex-start}.lg\:overflow-y-auto{overflow-y:auto}.lg\:border-r{border-right-style:var(--tw-border-style);border-right-width:1px}.lg\:pr-8{padding-right:calc(var(--spacing)*8)}}.dark\:border-neutral-700:where(.dark,.dark *){border-color:var(--color-neutral-700)}.dark\:border-neutral-800:where(.dark,.dark *){border-color:var(--color-neutral-800)}.dark\:bg-neutral-800\/50:where(.dark,.dark *){background-color:#26262680}@supports (color:color-mix(in lab,red,red)){.dark\:bg-neutral-800\/50:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-neutral-800)50%,transparent)}}.dark\:bg-neutral-900:where(.dark,.dark *){background-color:var(--color-neutral-900)}.dark\:bg-neutral-950:where(.dark,.dark *){background-color:var(--color-neutral-950)}.dark\:bg-neutral-950\/85:where(.dark,.dark *){background-color:#0a0a0ad9}@supports (color:color-mix(in lab,red,red)){.dark\:bg-neutral-950\/85:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-neutral-950)85%,transparent)}}.dark\:bg-sky-500\/20:where(.dark,.dark *){background-color:#00a5ef33}@supports (color:color-mix(in lab,red,red)){.dark\:bg-sky-500\/20:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-sky-500)20%,transparent)}}.dark\:bg-white:where(.dark,.dark *){background-color:var(--color-white)}.dark\:bg-\[linear-gradient\(theme\(colors\.neutral\.600\)_1px\,transparent_1px\)\,linear-gradient\(90deg\,theme\(colors\.neutral\.600\)_1px\,transparent_1px\)\]:where(.dark,.dark *){background-image:linear-gradient(#525252 1px,#0000 1px),linear-gradient(90deg,#525252 1px,#0000 1px)}.dark\:from-neutral-900:where(.dark,.dark *){--tw-gradient-from:var(--color-neutral-900);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:to-neutral-950:where(.dark,.dark *){--tw-gradient-to:var(--color-neutral-950);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:text-gray-900:where(.dark,.dark *){color:var(--color-gray-900)}.dark\:text-neutral-50:where(.dark,.dark *){color:var(--color-neutral-50)}.dark\:text-neutral-400:where(.dark,.dark *){color:var(--color-neutral-400)}.dark\:text-neutral-500:where(.dark,.dark *){color:var(--color-neutral-500)}.dark\:text-neutral-600:where(.dark,.dark *){color:var(--color-neutral-600)}.dark\:text-neutral-700:where(.dark,.dark *){color:var(--color-neutral-700)}.dark\:text-sky-400:where(.dark,.dark *){color:var(--color-sky-400)}.dark\:opacity-\[0\.12\]:where(.dark,.dark *){opacity:.12}.dark\:shadow-none:where(.dark,.dark *){--tw-shadow:0 0 #0000;box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.dark\:contrast-90:where(.dark,.dark *){--tw-contrast:contrast(90%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:hue-rotate-180:where(.dark,.dark *){--tw-hue-rotate:hue-rotate(180deg);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:invert:where(.dark,.dark *){--tw-invert:invert(100%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}@media(hover:hover){.dark\:hover\:bg-neutral-800:where(.dark,.dark *):hover{background-color:var(--color-neutral-800)}.dark\:hover\:bg-neutral-800\/50:where(.dark,.dark *):hover{background-color:#26262680}@supports (color:color-mix(in lab,red,red)){.dark\:hover\:bg-neutral-800\/50:where(.dark,.dark *):hover{background-color:color-mix(in oklab,var(--color-neutral-800)50%,transparent)}}.dark\:hover\:text-neutral-50:where(.dark,.dark *):hover{color:var(--color-neutral-50)}}}html{scroll-behavior:smooth}[id]{scroll-margin-top:calc(var(--header-height) + 2rem)}@keyframes fade-in{0%{opacity:0}to{opacity:1}}@keyframes fade-in-up{0%{opacity:0;transform:translateY(20px)}to{opacity:1;transform:translateY(0)}}@keyframes fade-in-down{0%{opacity:0;transform:translateY(-10px)}to{opacity:1;transform:translateY(0)}}@keyframes slide-in-left{0%{opacity:0;transform:translate(-20px)}to{opacity:1;transform:translate(0)}}@keyframes bounce-subtle{0%,to{transform:translateY(0)}50%{transform:translateY(-8px)}}.animate-fade-in{opacity:0;animation:.4s ease-out forwards fade-in}.animate-fade-in-up{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards fade-in-up}.animate-fade-in-down{opacity:0;animation:.25s ease-out forwards fade-in-down}.animate-slide-in-left{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards slide-in-left}.animate-bounce-subtle{animation:2s ease-in-out infinite bounce-subtle}.delay-100{animation-delay:.1s}.delay-200{animation-delay:.2s}.delay-300{animation-delay:.3s}.delay-400{animation-delay:.4s}.delay-500{animation-delay:.5s}.delay-600{animation-delay:.6s}.delay-700{animation-delay:.7s}.delay-800{animation-delay:.8s}@property --tw-translate-x{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-y{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-z{syntax:"*";inherits:false;initial-value:0}@property --tw-rotate-x{syntax:"*";inherits:false}@property --tw-rotate-y{syntax:"*";inherits:false}@property --tw-rotate-z{syntax:"*";inherits:false}@property --tw-skew-x{syntax:"*";inherits:false}@property --tw-skew-y{syntax:"*";inherits:false}@property --tw-space-y-reverse{syntax:"*";inherits:false;initial-value:0}@property --tw-border-style{syntax:"*";inherits:false;initial-value:solid}@property --tw-gradient-position{syntax:"*";inherits:false}@property --tw-gradient-from{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-via{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-to{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-stops{syntax:"*";inherits:false}@property --tw-gradient-via-stops{syntax:"*";inherits:false}@property --tw-gradient-from-position{syntax:"";inherits:false;initial-value:0%}@property --tw-gradient-via-position{syntax:"";inherits:false;initial-value:50%}@property --tw-gradient-to-position{syntax:"";inherits:false;initial-value:100%}@property --tw-leading{syntax:"*";inherits:false}@property --tw-font-weight{syntax:"*";inherits:false}@property --tw-tracking{syntax:"*";inherits:false}@property --tw-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-shadow-color{syntax:"*";inherits:false}@property --tw-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-inset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-shadow-color{syntax:"*";inherits:false}@property --tw-inset-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-ring-color{syntax:"*";inherits:false}@property --tw-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-ring-color{syntax:"*";inherits:false}@property --tw-inset-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-ring-inset{syntax:"*";inherits:false}@property --tw-ring-offset-width{syntax:"";inherits:false;initial-value:0}@property --tw-ring-offset-color{syntax:"*";inherits:false;initial-value:#fff}@property --tw-ring-offset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-blur{syntax:"*";inherits:false}@property --tw-brightness{syntax:"*";inherits:false}@property --tw-contrast{syntax:"*";inherits:false}@property --tw-grayscale{syntax:"*";inherits:false}@property --tw-hue-rotate{syntax:"*";inherits:false}@property --tw-invert{syntax:"*";inherits:false}@property --tw-opacity{syntax:"*";inherits:false}@property --tw-saturate{syntax:"*";inherits:false}@property --tw-sepia{syntax:"*";inherits:false}@property --tw-drop-shadow{syntax:"*";inherits:false}@property --tw-drop-shadow-color{syntax:"*";inherits:false}@property --tw-drop-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-drop-shadow-size{syntax:"*";inherits:false}@property --tw-backdrop-blur{syntax:"*";inherits:false}@property --tw-backdrop-brightness{syntax:"*";inherits:false}@property --tw-backdrop-contrast{syntax:"*";inherits:false}@property --tw-backdrop-grayscale{syntax:"*";inherits:false}@property --tw-backdrop-hue-rotate{syntax:"*";inherits:false}@property --tw-backdrop-invert{syntax:"*";inherits:false}@property --tw-backdrop-opacity{syntax:"*";inherits:false}@property --tw-backdrop-saturate{syntax:"*";inherits:false}@property --tw-backdrop-sepia{syntax:"*";inherits:false}@property --tw-duration{syntax:"*";inherits:false}@property --tw-ease{syntax:"*";inherits:false} diff --git a/docs/_astro/index.Ds9Y8AeZ.css b/docs/_astro/index.Ds9Y8AeZ.css deleted file mode 100644 index 0d3641c..0000000 --- a/docs/_astro/index.Ds9Y8AeZ.css +++ /dev/null @@ -1 +0,0 @@ -@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-vietnamese-wght-normal.BUzh504Q.woff2) format("woff2-variations");unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB}@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-latin-ext-wght-normal.CcLUaPy7.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:Bricolage Grotesque Variable;font-style:normal;font-display:swap;font-weight:200 800;src:url(/_astro/bricolage-grotesque-latin-wght-normal.DLoelf7F.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}@font-face{font-family:DM Sans Variable;font-style:normal;font-display:swap;font-weight:100 1000;src:url(/_astro/dm-sans-latin-ext-wght-normal.BOFOeGcA.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:DM Sans Variable;font-style:normal;font-display:swap;font-weight:100 1000;src:url(/_astro/dm-sans-latin-wght-normal.Xz1IZZA0.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(data:font/woff2;base64,d09GMgABAAAAAAfsABQAAAAAEAwAAAeCAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGhwbHhwoP0hWQVJbBmA/U1RBVIFiJyYAdC9qEQgKhGSEAAsgADCGCAE2AiQDOgQgBYlMB4EUDAcbLQ4onoexrSC/2ZyLAa8p8VHB8/x3Vue+V0hVJalMJg2nx/TCrQXxBeqLjQG7FyM1WEa/X1tEXN7cFz9EJEMmMUz3RihWSSKeQCbcIou0izz/C8v+fq3VfajEa9gDD11CImXS7qL/RJFVzC1qiB6KmKeD6TZdQ6IRGv78dL6uSVVCfgni5mzu7kcgQBgAEAQTQRCoL++STTYybkJxNfQxAAIAGu8OdEB9teW2jh4BpgDqFjAeSEByW3zFP0CBBgNMsMCGEDjgggdhiEAUAeIIED7ABTDUEnkIE9Q9ahFgKttcVhApo4ACB4qobHaccgDfEjFO6aaWUhjMLt2SyIvHKoDqoA4CSUwEIYQCEjhAO9R1G6keDeDZGjNo+AhxOjCEGTr1WeIF3kYBiLAOKvkJSMiKX0VdAyQt3SDJClCkxJCHkCzfqyVTriJZLcolS32JZHUekq2TYNkYtCtjYHMQXSxGjXDz2t/yLWXzDzxz+o3zFwDEaN23F+13pyMdQAEaSKAR9vcGq4A4MTSKCElGW+M7UcY7xqkggITb28ZJhlqc9q2twYKTt0NjixBgYvO9BIihEBLYuOFXQzfIQ7dXGUEEEgFDooBfAzqiQbpJrhiWSuKJCRFKYbHCyJKI2G5GiZbNAvgAu5pc3vwx4G+g3aDkhklABiSz0BICXrYghtYhx/cdJ+44rY2oZ0aMNRFz3VZjb6W33F3gzltqtOCV8tTHSpOeXuItfvr5lCdfzFpqtEitvqdcdGGFd28ZqqC0tPbeChGXgrIlnhSWu/eUso4uKWFLugyDzQJhflY4659+WjQ++6x72WUMv9G8mw6QJl7BVxX5fe/kpUsOvnZwee9uQ0cGXYd0o89XB2748sDSnt8d2VphdOTTgceDVvOds0v9P/s7HPq15aGun/6Vllb56f1dl0t1LejqrNkpdRZsG8TOnM5vkBG5oiVyVGnS8LHps5cfNWJs6qKPfaNSxiQNBUm3cKNWROr0GSur7Za31k1vieq7LH11VF+jXdRIasRKflc7jkobm1Z9te1IyZA0pDkhLR98+H37Zf1c/8at+dB7x+7GfVyTfJMPiYztsnl59Y5l4j+0n1RXlpHnF3Tq7HecmNF/CJodEMAikruxiyJaGLvHOdAfoA+oDvpjBm2b91cHGRZMU9n25xEU0A8fgEEAdKI3Q1iDtc034sug5YVMkE2jsE+BIkwSoQ3gxXMqz9tELp48bd0cFKOKS7xYjEuXBnZP5ia7DyiO/X/YI+PQSbt2uSdqAkWL9nQbV1XB94/+uPfdZz8dnXYFBYrcTl2SIR/ybxJNJPz/Gupb0JaZeens2ekC7EKr8t+Ls/P5VJPYJdHKyqfg2nqU6bhlidzcddQV/7MmecTzJ5VPcKXkNKSEogHjYFx6QZ7rQ+FSe8njaiNuOnXS8H2ScQ619c2mC3VTtauL0rRbXd/CkSOP37FY9Zkjz8+GibYUMOEWF+RdrFS8Ecv1SHOpPUPZGEIpjPvFyU5cXKjd6OXqorTqy9GwRd++HVufPGnVsW+aO3vggKZ18jR9sXaTC1PWTEsVUaK0FkNySbTQDqlm2PfDjZcu4aalnSLKjnOoYQ0nUlqqXcGpPu/4VgV/xU2pAqW4BW3qzhQ8/hFKhV2qE3+BKAtDqBXjfgnVdH4y0wg5tbVNRenNdTWOrenWLcupQdmsbq5b+18piTe/xRdp1xbILxNPJGInm2z6hoB21Lal0i+ePTtd7B45+3XhFJ329evskXm7qurUVREotqSluSo/L29d3qDhI4YOQqWhI4YNvBNfsMHeXKemXrxQfKeuPOGRVayA3JtkJKEgbPp+dXUDluddutRYLFoXGXWX6N3WFaGLbQtRSitVYNacTNSdy7AaG/HSaUEANcBoGXNdcZvZsOqQ1icBDv21/gzAoYPHH/WDW0qNR3QTYKEAEHig6o13NXbND06CQPlRtYjGNnSktRc09k1mAMDvAlDKfQjgy6fssInlfzmNAjKkDxoxHOBLdVRAIVt9j4qo+hA1w9T1aNBNTUOTTNUHLbqokE+UAfJXCIGw/IxCSL5GRUJeR40rL/UxTm4Q08H6MbCs70ObuNyIIXrINHQYInF06UUlevTjbQzTh5upiDMzMMogUtEnjPs/Y7jAHCJeB0GBHh04tC6FiB6ZFB1oArUSIoFoqhzCeAN6lHwm0T4C3VVPWvjpSMXReuWesMEcoqrmgtNBGd2noWeV0hNAz9rFeShNJxHGsPa3HXeKTk8b55hahySYHaYKKFFLpCfN8rsoaJn01CR04Gkc+5k7KVTCmClX8Q10HCrUEkVlSX+XO33oQR9609tJ516H497WSobWs5Up6TLaS10/dessIskgJSLiDlWvHVUywpkQ7hdPZqGyiEF0uVQerVcPamT1A3eKXdyI1vG9OoflrSXihZ1qqGE3nhmAgiIbRCQgPLEPtOM3UQwTLYaYYomNlpA44opnjV6jkD6id80OOrzf6BzmMD6eEa1zKyeYG1fzfEf16V6jw9XYOaar1/b2kP/IYX8oR2mcFvv2GtBV3JXgd437AQAA) format("woff2-variations");unicode-range:U+0460-052F,U+1C80-1C8A,U+20B4,U+2DE0-2DFF,U+A640-A69F,U+FE2E-FE2F}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-cyrillic-wght-normal.D73BlboJ.woff2) format("woff2-variations");unicode-range:U+0301,U+0400-045F,U+0490-0491,U+04B0-04B1,U+2116}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-greek-wght-normal.Bw9x6K1M.woff2) format("woff2-variations");unicode-range:U+0370-0377,U+037A-037F,U+0384-038A,U+038C,U+038E-03A1,U+03A3-03FF}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-vietnamese-wght-normal.Bt-aOZkq.woff2) format("woff2-variations");unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-latin-ext-wght-normal.DBQx-q_a.woff2) format("woff2-variations");unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF}@font-face{font-family:JetBrains Mono Variable;font-style:normal;font-display:swap;font-weight:100 800;src:url(/_astro/jetbrains-mono-latin-wght-normal.B9CIFXIH.woff2) format("woff2-variations");unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD}/*! tailwindcss v4.1.18 | MIT License | https://tailwindcss.com */@layer properties{@supports (((-webkit-hyphens:none)) and (not (margin-trim:inline))) or ((-moz-orient:inline) and (not (color:rgb(from red r g b)))){*,:before,:after,::backdrop{--tw-translate-x:0;--tw-translate-y:0;--tw-translate-z:0;--tw-rotate-x:initial;--tw-rotate-y:initial;--tw-rotate-z:initial;--tw-skew-x:initial;--tw-skew-y:initial;--tw-space-y-reverse:0;--tw-border-style:solid;--tw-gradient-position:initial;--tw-gradient-from:#0000;--tw-gradient-via:#0000;--tw-gradient-to:#0000;--tw-gradient-stops:initial;--tw-gradient-via-stops:initial;--tw-gradient-from-position:0%;--tw-gradient-via-position:50%;--tw-gradient-to-position:100%;--tw-leading:initial;--tw-font-weight:initial;--tw-tracking:initial;--tw-shadow:0 0 #0000;--tw-shadow-color:initial;--tw-shadow-alpha:100%;--tw-inset-shadow:0 0 #0000;--tw-inset-shadow-color:initial;--tw-inset-shadow-alpha:100%;--tw-ring-color:initial;--tw-ring-shadow:0 0 #0000;--tw-inset-ring-color:initial;--tw-inset-ring-shadow:0 0 #0000;--tw-ring-inset:initial;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-offset-shadow:0 0 #0000;--tw-blur:initial;--tw-brightness:initial;--tw-contrast:initial;--tw-grayscale:initial;--tw-hue-rotate:initial;--tw-invert:initial;--tw-opacity:initial;--tw-saturate:initial;--tw-sepia:initial;--tw-drop-shadow:initial;--tw-drop-shadow-color:initial;--tw-drop-shadow-alpha:100%;--tw-drop-shadow-size:initial;--tw-backdrop-blur:initial;--tw-backdrop-brightness:initial;--tw-backdrop-contrast:initial;--tw-backdrop-grayscale:initial;--tw-backdrop-hue-rotate:initial;--tw-backdrop-invert:initial;--tw-backdrop-opacity:initial;--tw-backdrop-saturate:initial;--tw-backdrop-sepia:initial;--tw-duration:initial;--tw-ease:initial}}}@layer theme{:root,:host{--font-sans:"DM Sans Variable",system-ui,sans-serif;--font-mono:"JetBrains Mono Variable","SF Mono",Consolas,monospace;--color-sky-400:oklch(74.6% .16 232.661);--color-sky-500:oklch(68.5% .169 237.323);--color-sky-600:oklch(58.8% .158 241.966);--color-gray-50:oklch(98.5% .002 247.839);--color-gray-100:oklch(96.7% .003 264.542);--color-gray-200:oklch(92.8% .006 264.531);--color-gray-300:oklch(87.2% .01 258.338);--color-gray-400:oklch(70.7% .022 261.325);--color-gray-500:oklch(55.1% .027 264.364);--color-gray-600:oklch(44.6% .03 256.802);--color-gray-900:oklch(21% .034 264.665);--color-gray-950:oklch(13% .028 261.692);--color-neutral-50:oklch(98.5% 0 0);--color-neutral-400:oklch(70.8% 0 0);--color-neutral-500:oklch(55.6% 0 0);--color-neutral-600:oklch(43.9% 0 0);--color-neutral-700:oklch(37.1% 0 0);--color-neutral-800:oklch(26.9% 0 0);--color-neutral-900:oklch(20.5% 0 0);--color-neutral-950:oklch(14.5% 0 0);--color-black:#000;--color-white:#fff;--spacing:.25rem;--container-2xl:42rem;--container-3xl:48rem;--container-4xl:56rem;--container-6xl:72rem;--text-xs:.75rem;--text-xs--line-height:calc(1/.75);--text-sm:.875rem;--text-sm--line-height:calc(1.25/.875);--text-base:1rem;--text-base--line-height: 1.5 ;--text-lg:1.125rem;--text-lg--line-height:calc(1.75/1.125);--text-xl:1.25rem;--text-xl--line-height:calc(1.75/1.25);--text-3xl:1.875rem;--text-3xl--line-height: 1.2 ;--text-4xl:2.25rem;--text-4xl--line-height:calc(2.5/2.25);--font-weight-medium:500;--font-weight-semibold:600;--font-weight-bold:700;--tracking-tight:-.025em;--tracking-wider:.05em;--radius-md:.375rem;--radius-lg:.5rem;--radius-2xl:1rem;--ease-out:cubic-bezier(0,0,.2,1);--blur-xl:24px;--default-transition-duration:.15s;--default-transition-timing-function:cubic-bezier(.4,0,.2,1);--default-font-family:var(--font-sans);--default-mono-font-family:var(--font-mono);--color-accent:oklch(68.5% .169 237.323);--color-accent-light:oklch(74.6% .16 232.661);--font-display:"Bricolage Grotesque Variable",system-ui,sans-serif;--header-height:4rem;--sidebar-width:260px;--content-max-width:800px;--section-padding-x:2rem;--transition-fast:.15s cubic-bezier(.4,0,.2,1)}}@layer base{*,:after,:before,::backdrop{box-sizing:border-box;border:0 solid;margin:0;padding:0}::file-selector-button{box-sizing:border-box;border:0 solid;margin:0;padding:0}html,:host{-webkit-text-size-adjust:100%;tab-size:4;line-height:1.5;font-family:var(--default-font-family,ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji");font-feature-settings:var(--default-font-feature-settings,normal);font-variation-settings:var(--default-font-variation-settings,normal);-webkit-tap-highlight-color:transparent}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;-webkit-text-decoration:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:var(--default-mono-font-family,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace);font-feature-settings:var(--default-mono-font-feature-settings,normal);font-variation-settings:var(--default-mono-font-variation-settings,normal);font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}:-moz-focusring{outline:auto}progress{vertical-align:baseline}summary{display:list-item}ol,ul,menu{list-style:none}img,svg,video,canvas,audio,iframe,embed,object{vertical-align:middle;display:block}img,video{max-width:100%;height:auto}button,input,select,optgroup,textarea{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}::file-selector-button{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}:where(select:is([multiple],[size])) optgroup{font-weight:bolder}:where(select:is([multiple],[size])) optgroup option{padding-inline-start:20px}::file-selector-button{margin-inline-end:4px}::placeholder{opacity:1}@supports (not ((-webkit-appearance:-apple-pay-button))) or (contain-intrinsic-size:1px){::placeholder{color:currentColor}@supports (color:color-mix(in lab,red,red)){::placeholder{color:color-mix(in oklab,currentcolor 50%,transparent)}}}textarea{resize:vertical}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-date-and-time-value{min-height:1lh;text-align:inherit}::-webkit-datetime-edit{display:inline-flex}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-datetime-edit{padding-block:0}::-webkit-datetime-edit-year-field{padding-block:0}::-webkit-datetime-edit-month-field{padding-block:0}::-webkit-datetime-edit-day-field{padding-block:0}::-webkit-datetime-edit-hour-field{padding-block:0}::-webkit-datetime-edit-minute-field{padding-block:0}::-webkit-datetime-edit-second-field{padding-block:0}::-webkit-datetime-edit-millisecond-field{padding-block:0}::-webkit-datetime-edit-meridiem-field{padding-block:0}::-webkit-calendar-picker-indicator{line-height:1}:-moz-ui-invalid{box-shadow:none}button,input:where([type=button],[type=reset],[type=submit]){appearance:button}::file-selector-button{appearance:button}::-webkit-inner-spin-button{height:auto}::-webkit-outer-spin-button{height:auto}[hidden]:where(:not([hidden=until-found])){display:none!important}html{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;height:100%}body{font-family:var(--font-sans);color:#020618;background-color:#f8fafc;font-size:16px;font-weight:400;line-height:1.7;overflow-x:hidden}.dark body{color:#fafafa;background-color:#0a0a0a}h1,h2,h3,h4,h5,h6{font-family:var(--font-display);letter-spacing:-.02em;color:#020618;font-weight:700;line-height:1.2}.dark h1,.dark h2,.dark h3,.dark h4,.dark h5,.dark h6{color:#fafafa}h1{letter-spacing:-.03em;font-size:clamp(2.5rem,6vw,4.5rem);font-weight:800}h2{margin-top:3rem;margin-bottom:1.5rem;font-size:clamp(1.75rem,4vw,2.5rem)}h3{margin-top:2rem;margin-bottom:1rem;font-size:clamp(1.25rem,2vw,1.5rem)}p{margin-bottom:1.25rem}a{color:var(--color-accent);transition:color var(--transition-fast);word-break:break-word;text-decoration:none}a:hover{color:var(--color-accent-light)}code{font-family:var(--font-mono);background-color:#0206180d;border-radius:4px;padding:.2em .4em;font-size:.875em}.dark code{background-color:#a1a1a126}pre{font-family:var(--font-mono);background-color:#e2e8f0;border-radius:8px;padding:1.25rem;line-height:1.6;overflow-x:auto}.dark pre{background-color:#171717}pre>code{padding:0;font-size:.875rem;background-color:#0000!important}ul,ol{margin-bottom:1.25rem;padding-left:1.5rem}ul{list-style-type:disc}ol{list-style-type:decimal}li{margin-bottom:.5rem}ol ol,ul ol,ul ul ol,ul ol ol,ol ul ol,ol ol ol{list-style-type:decimal}blockquote{border-left:3px solid var(--color-accent);color:#45556c;margin:1.5rem 0;padding-left:1.5rem;font-style:italic}.dark blockquote{color:#a1a1a1}strong{font-weight:600}:focus-visible{outline:2px solid var(--color-accent);outline-offset:2px}}@layer components{.section-container{max-width:calc(var(--content-max-width) + var(--sidebar-width) + 4rem);padding:0 var(--section-padding-x);margin:0 auto}.prose-spec{max-width:var(--content-max-width)}.prose-spec h2{border-bottom:1px solid oklch(92.9% .013 255.508);margin-top:3rem;margin-bottom:1.5rem;padding-bottom:.75rem;font-size:1.75rem}.dark .prose-spec h2{border-bottom-color:#262626}.prose-spec h2:first-child{margin-top:0}.prose-spec h3{color:#45556c;margin-top:2rem;margin-bottom:1rem;font-size:1.25rem;font-weight:600}.dark .prose-spec h3{color:#a1a1a1}.prose-spec p{color:#45556c}.dark .prose-spec p{color:#a1a1a1}.prose-spec strong{color:#020618}.dark .prose-spec strong{color:#fafafa}.prose-spec li{color:#45556c}.dark .prose-spec li{color:#a1a1a1}.prose-spec ol{counter-reset:item;padding-left:2.5rem;list-style:none}.prose-spec ol>li{counter-increment:item;position:relative}.prose-spec ol>li:before{content:counters(item,".")".";text-align:right;color:#90a1b9;width:2rem;font-weight:500;position:absolute;left:-2.5rem}.dark .prose-spec ol>li:before{color:#737373}.prose-spec img{border-radius:8px;max-width:100%;height:auto;margin:2rem 0}.prose-spec p:last-child{margin-bottom:0}.nav-link.active{color:oklch(50% .134 242.749)!important;background-color:oklab(58.8% -.0742593 -.139462/.15)!important}.dark .nav-link.active{color:oklch(74.6% .16 232.661)!important;background-color:oklab(58.8% -.0742593 -.139462/.2)!important}.sidebar-link.active{color:oklch(50% .134 242.749)!important;background-color:oklab(58.8% -.0742593 -.139462/.15)!important}.dark .sidebar-link.active{color:oklch(74.6% .16 232.661)!important;background-color:oklab(58.8% -.0742593 -.139462/.2)!important}#spec-sidebar::-webkit-scrollbar{width:4px}#spec-sidebar::-webkit-scrollbar-track{background:0 0}#spec-sidebar::-webkit-scrollbar-thumb{background-color:#e2e8f0;border-radius:2px}.dark #spec-sidebar::-webkit-scrollbar-thumb{background-color:#262626}}@layer utilities{.pointer-events-none{pointer-events:none}.invisible{visibility:hidden}.visible{visibility:visible}.absolute{position:absolute}.fixed{position:fixed}.relative{position:relative}.static{position:static}.inset-0{inset:calc(var(--spacing)*0)}.inset-x-0{inset-inline:calc(var(--spacing)*0)}.top-0{top:calc(var(--spacing)*0)}.top-full{top:100%}.right-6{right:calc(var(--spacing)*6)}.bottom-0{bottom:calc(var(--spacing)*0)}.bottom-6{bottom:calc(var(--spacing)*6)}.bottom-8{bottom:calc(var(--spacing)*8)}.left-0{left:calc(var(--spacing)*0)}.left-1\/2{left:50%}.z-10{z-index:10}.z-20{z-index:20}.z-40{z-index:40}.z-50{z-index:50}.mx-auto{margin-inline:auto}.my-28{margin-block:calc(var(--spacing)*28)}.mt-2{margin-top:calc(var(--spacing)*2)}.mt-8{margin-top:calc(var(--spacing)*8)}.mb-2{margin-bottom:calc(var(--spacing)*2)}.mb-3{margin-bottom:calc(var(--spacing)*3)}.mb-4{margin-bottom:calc(var(--spacing)*4)}.mb-6{margin-bottom:calc(var(--spacing)*6)}.mb-8{margin-bottom:calc(var(--spacing)*8)}.mb-10{margin-bottom:calc(var(--spacing)*10)}.mb-12{margin-bottom:calc(var(--spacing)*12)}.mb-16{margin-bottom:calc(var(--spacing)*16)}.block{display:block}.contents{display:contents}.flex{display:flex}.grid{display:grid}.hidden{display:none}.inline{display:inline}.inline-flex{display:inline-flex}.table{display:table}.h-3\.5{height:calc(var(--spacing)*3.5)}.h-4{height:calc(var(--spacing)*4)}.h-5{height:calc(var(--spacing)*5)}.h-6{height:calc(var(--spacing)*6)}.h-12{height:calc(var(--spacing)*12)}.h-16{height:calc(var(--spacing)*16)}.h-auto{height:auto}.max-h-\[70vh\]{max-height:70vh}.min-h-\[75vh\]{min-height:75vh}.min-h-screen{min-height:100vh}.w-3\.5{width:calc(var(--spacing)*3.5)}.w-4{width:calc(var(--spacing)*4)}.w-5{width:calc(var(--spacing)*5)}.w-6{width:calc(var(--spacing)*6)}.w-12{width:calc(var(--spacing)*12)}.w-full{width:100%}.max-w-2xl{max-width:var(--container-2xl)}.max-w-3xl{max-width:var(--container-3xl)}.max-w-4xl{max-width:var(--container-4xl)}.max-w-6xl{max-width:var(--container-6xl)}.min-w-0{min-width:calc(var(--spacing)*0)}.min-w-full{min-width:100%}.flex-1{flex:1}.flex-shrink-0,.shrink-0{flex-shrink:0}.-translate-x-1\/2{--tw-translate-x: -50% ;translate:var(--tw-translate-x)var(--tw-translate-y)}.-translate-y-1{--tw-translate-y:calc(var(--spacing)*-1);translate:var(--tw-translate-x)var(--tw-translate-y)}.translate-y-\[-100\%\]{--tw-translate-y:-100%;translate:var(--tw-translate-x)var(--tw-translate-y)}.rotate-180{rotate:180deg}.transform{transform:var(--tw-rotate-x,)var(--tw-rotate-y,)var(--tw-rotate-z,)var(--tw-skew-x,)var(--tw-skew-y,)}.cursor-pointer{cursor:pointer}.grid-rows-\[0fr\]{grid-template-rows:0fr}.grid-rows-\[1fr\]{grid-template-rows:1fr}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.items-center{align-items:center}.justify-between{justify-content:space-between}.justify-center{justify-content:center}.gap-1{gap:calc(var(--spacing)*1)}.gap-1\.5{gap:calc(var(--spacing)*1.5)}.gap-2{gap:calc(var(--spacing)*2)}.gap-3{gap:calc(var(--spacing)*3)}.gap-4{gap:calc(var(--spacing)*4)}.gap-8{gap:calc(var(--spacing)*8)}:where(.space-y-0>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*0)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*0)*calc(1 - var(--tw-space-y-reverse)))}:where(.space-y-1>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*1)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*1)*calc(1 - var(--tw-space-y-reverse)))}.overflow-hidden{overflow:hidden}.overflow-y-auto{overflow-y:auto}.rounded{border-radius:.25rem}.rounded-2xl{border-radius:var(--radius-2xl)}.rounded-full{border-radius:3.40282e38px}.rounded-lg{border-radius:var(--radius-lg)}.rounded-md{border-radius:var(--radius-md)}.rounded-t-2xl{border-top-left-radius:var(--radius-2xl);border-top-right-radius:var(--radius-2xl)}.border{border-style:var(--tw-border-style);border-width:1px}.border-t{border-top-style:var(--tw-border-style);border-top-width:1px}.border-b{border-bottom-style:var(--tw-border-style);border-bottom-width:1px}.border-gray-200{border-color:var(--color-gray-200)}.border-transparent{border-color:#0000}.bg-black\/50{background-color:#00000080}@supports (color:color-mix(in lab,red,red)){.bg-black\/50{background-color:color-mix(in oklab,var(--color-black)50%,transparent)}}.bg-gray-50{background-color:var(--color-gray-50)}.bg-gray-50\/85{background-color:#f9fafbd9}@supports (color:color-mix(in lab,red,red)){.bg-gray-50\/85{background-color:color-mix(in oklab,var(--color-gray-50)85%,transparent)}}.bg-gray-100{background-color:var(--color-gray-100)}.bg-gray-900{background-color:var(--color-gray-900)}.bg-sky-500\/15{background-color:#00a5ef26}@supports (color:color-mix(in lab,red,red)){.bg-sky-500\/15{background-color:color-mix(in oklab,var(--color-sky-500)15%,transparent)}}.bg-sky-600{background-color:var(--color-sky-600)}.bg-transparent{background-color:#0000}.bg-white{background-color:var(--color-white)}.bg-gradient-to-b{--tw-gradient-position:to bottom in oklab;background-image:linear-gradient(var(--tw-gradient-stops))}.bg-\[linear-gradient\(theme\(colors\.gray\.950\)_1px\,transparent_1px\)\,linear-gradient\(90deg\,theme\(colors\.gray\.950\)_1px\,transparent_1px\)\]{background-image:linear-gradient(#030712 1px,#0000 1px),linear-gradient(90deg,#030712 1px,#0000 1px)}.from-gray-100{--tw-gradient-from:var(--color-gray-100);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.to-gray-50{--tw-gradient-to:var(--color-gray-50);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.\[mask-image\:linear-gradient\(to_bottom\,black_20\%\,transparent_80\%\)\]{-webkit-mask-image:linear-gradient(#000 20%,#0000 80%);mask-image:linear-gradient(#000 20%,#0000 80%)}.bg-\[size\:60px_60px\]{background-size:60px 60px}.bg-center{background-position:50%}.p-1\.5{padding:calc(var(--spacing)*1.5)}.p-2{padding:calc(var(--spacing)*2)}.p-4{padding:calc(var(--spacing)*4)}.p-6{padding:calc(var(--spacing)*6)}.p-8{padding:calc(var(--spacing)*8)}.px-2{padding-inline:calc(var(--spacing)*2)}.px-2\.5{padding-inline:calc(var(--spacing)*2.5)}.px-3{padding-inline:calc(var(--spacing)*3)}.px-4{padding-inline:calc(var(--spacing)*4)}.px-5{padding-inline:calc(var(--spacing)*5)}.px-6{padding-inline:calc(var(--spacing)*6)}.py-1{padding-block:calc(var(--spacing)*1)}.py-1\.5{padding-block:calc(var(--spacing)*1.5)}.py-2{padding-block:calc(var(--spacing)*2)}.py-2\.5{padding-block:calc(var(--spacing)*2.5)}.py-3{padding-block:calc(var(--spacing)*3)}.py-4{padding-block:calc(var(--spacing)*4)}.py-6{padding-block:calc(var(--spacing)*6)}.py-20{padding-block:calc(var(--spacing)*20)}.pt-8{padding-top:calc(var(--spacing)*8)}.pt-12{padding-top:calc(var(--spacing)*12)}.pt-16{padding-top:calc(var(--spacing)*16)}.pr-4{padding-right:calc(var(--spacing)*4)}.pb-6{padding-bottom:calc(var(--spacing)*6)}.pb-24{padding-bottom:calc(var(--spacing)*24)}.pl-6{padding-left:calc(var(--spacing)*6)}.text-center{text-align:center}.text-left{text-align:left}.font-display{font-family:var(--font-display)}.font-mono{font-family:var(--font-mono)}.text-3xl{font-size:var(--text-3xl);line-height:var(--tw-leading,var(--text-3xl--line-height))}.text-base{font-size:var(--text-base);line-height:var(--tw-leading,var(--text-base--line-height))}.text-lg{font-size:var(--text-lg);line-height:var(--tw-leading,var(--text-lg--line-height))}.text-sm{font-size:var(--text-sm);line-height:var(--tw-leading,var(--text-sm--line-height))}.text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.text-xs{font-size:var(--text-xs);line-height:var(--tw-leading,var(--text-xs--line-height))}.text-\[0\.8125rem\]{font-size:.8125rem}.text-\[8rem\]{font-size:8rem}.leading-none{--tw-leading:1;line-height:1}.font-bold{--tw-font-weight:var(--font-weight-bold);font-weight:var(--font-weight-bold)}.font-medium{--tw-font-weight:var(--font-weight-medium);font-weight:var(--font-weight-medium)}.font-semibold{--tw-font-weight:var(--font-weight-semibold);font-weight:var(--font-weight-semibold)}.tracking-tight{--tw-tracking:var(--tracking-tight);letter-spacing:var(--tracking-tight)}.tracking-wider{--tw-tracking:var(--tracking-wider);letter-spacing:var(--tracking-wider)}.whitespace-nowrap{white-space:nowrap}.text-gray-300{color:var(--color-gray-300)}.text-gray-400{color:var(--color-gray-400)}.text-gray-500{color:var(--color-gray-500)}.text-gray-600{color:var(--color-gray-600)}.text-gray-950{color:var(--color-gray-950)}.text-sky-600{color:var(--color-sky-600)}.text-white{color:var(--color-white)}.uppercase{text-transform:uppercase}.no-underline{text-decoration-line:none}.opacity-0{opacity:0}.opacity-\[0\.06\]{opacity:.06}.shadow-lg{--tw-shadow:0 8px 30px var(--tw-shadow-color,#0000001f);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.shadow-sm{--tw-shadow:0 1px 2px var(--tw-shadow-color,#0000000d);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.shadow-xl{--tw-shadow:0 20px 25px -5px var(--tw-shadow-color,#0000001a),0 8px 10px -6px var(--tw-shadow-color,#0000001a);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.filter{filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.backdrop-blur-xl{--tw-backdrop-blur:blur(var(--blur-xl));-webkit-backdrop-filter:var(--tw-backdrop-blur,)var(--tw-backdrop-brightness,)var(--tw-backdrop-contrast,)var(--tw-backdrop-grayscale,)var(--tw-backdrop-hue-rotate,)var(--tw-backdrop-invert,)var(--tw-backdrop-opacity,)var(--tw-backdrop-saturate,)var(--tw-backdrop-sepia,);backdrop-filter:var(--tw-backdrop-blur,)var(--tw-backdrop-brightness,)var(--tw-backdrop-contrast,)var(--tw-backdrop-grayscale,)var(--tw-backdrop-hue-rotate,)var(--tw-backdrop-invert,)var(--tw-backdrop-opacity,)var(--tw-backdrop-saturate,)var(--tw-backdrop-sepia,)}.transition-\[grid-template-rows\]{transition-property:grid-template-rows;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-all{transition-property:all;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-colors{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-opacity{transition-property:opacity;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-transform{transition-property:transform,translate,scale,rotate;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.delay-100{transition-delay:.1s}.delay-200{transition-delay:.2s}.delay-300{transition-delay:.3s}.delay-400{transition-delay:.4s}.delay-700{transition-delay:.7s}.duration-150{--tw-duration:.15s;transition-duration:.15s}.duration-200{--tw-duration:.2s;transition-duration:.2s}.duration-300{--tw-duration:.3s;transition-duration:.3s}.ease-out{--tw-ease:var(--ease-out);transition-timing-function:var(--ease-out)}.\[-webkit-mask-image\:linear-gradient\(to_bottom\,black_20\%\,transparent_80\%\)\]{-webkit-mask-image:linear-gradient(#000 20%,#0000 80%)}@media(hover:hover){.group-hover\:opacity-100:is(:where(.group):hover *){opacity:1}.hover\:-translate-y-0\.5:hover{--tw-translate-y:calc(var(--spacing)*-.5);translate:var(--tw-translate-x)var(--tw-translate-y)}.hover\:border-sky-600:hover{border-color:var(--color-sky-600)}.hover\:bg-gray-100:hover{background-color:var(--color-gray-100)}.hover\:bg-sky-500:hover{background-color:var(--color-sky-500)}.hover\:bg-white\/50:hover{background-color:#ffffff80}@supports (color:color-mix(in lab,red,red)){.hover\:bg-white\/50:hover{background-color:color-mix(in oklab,var(--color-white)50%,transparent)}}.hover\:text-gray-950:hover{color:var(--color-gray-950)}.hover\:text-sky-400:hover{color:var(--color-sky-400)}.hover\:text-sky-600:hover{color:var(--color-sky-600)}.hover\:shadow-md:hover{--tw-shadow:0 4px 12px var(--tw-shadow-color,#00000014);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}}.data-\[open\]\:visible[data-open]{visibility:visible}.data-\[open\]\:translate-y-0[data-open]{--tw-translate-y:calc(var(--spacing)*0);translate:var(--tw-translate-x)var(--tw-translate-y)}.data-\[open\]\:opacity-100[data-open]{opacity:1}@media(min-width:40rem){.sm\:grid-cols-2{grid-template-columns:repeat(2,minmax(0,1fr))}.sm\:flex-row{flex-direction:row}.sm\:items-center{align-items:center}.sm\:justify-between{justify-content:space-between}.sm\:p-8{padding:calc(var(--spacing)*8)}.sm\:px-6{padding-inline:calc(var(--spacing)*6)}.sm\:py-28{padding-block:calc(var(--spacing)*28)}.sm\:text-4xl{font-size:var(--text-4xl);line-height:var(--tw-leading,var(--text-4xl--line-height))}.sm\:text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.sm\:text-\[12rem\]{font-size:12rem}}@media(min-width:48rem){.md\:block{display:block}.md\:flex{display:flex}.md\:hidden{display:none}}@media(min-width:64rem){.lg\:sticky{position:sticky}.lg\:top-24{top:calc(var(--spacing)*24)}.lg\:mr-8{margin-right:calc(var(--spacing)*8)}.lg\:block{display:block}.lg\:flex{display:flex}.lg\:hidden{display:none}.lg\:max-h-\[calc\(100vh-8rem\)\]{max-height:calc(100vh - 8rem)}.lg\:w-64{width:calc(var(--spacing)*64)}.lg\:flex-shrink-0{flex-shrink:0}.lg\:gap-8{gap:calc(var(--spacing)*8)}.lg\:self-start{align-self:flex-start}.lg\:overflow-y-auto{overflow-y:auto}.lg\:border-r{border-right-style:var(--tw-border-style);border-right-width:1px}.lg\:pr-8{padding-right:calc(var(--spacing)*8)}}.dark\:border-neutral-700:where(.dark,.dark *){border-color:var(--color-neutral-700)}.dark\:border-neutral-800:where(.dark,.dark *){border-color:var(--color-neutral-800)}.dark\:bg-neutral-800\/50:where(.dark,.dark *){background-color:#26262680}@supports (color:color-mix(in lab,red,red)){.dark\:bg-neutral-800\/50:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-neutral-800)50%,transparent)}}.dark\:bg-neutral-900:where(.dark,.dark *){background-color:var(--color-neutral-900)}.dark\:bg-neutral-950:where(.dark,.dark *){background-color:var(--color-neutral-950)}.dark\:bg-neutral-950\/85:where(.dark,.dark *){background-color:#0a0a0ad9}@supports (color:color-mix(in lab,red,red)){.dark\:bg-neutral-950\/85:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-neutral-950)85%,transparent)}}.dark\:bg-sky-500\/20:where(.dark,.dark *){background-color:#00a5ef33}@supports (color:color-mix(in lab,red,red)){.dark\:bg-sky-500\/20:where(.dark,.dark *){background-color:color-mix(in oklab,var(--color-sky-500)20%,transparent)}}.dark\:bg-white:where(.dark,.dark *){background-color:var(--color-white)}.dark\:bg-\[linear-gradient\(theme\(colors\.neutral\.600\)_1px\,transparent_1px\)\,linear-gradient\(90deg\,theme\(colors\.neutral\.600\)_1px\,transparent_1px\)\]:where(.dark,.dark *){background-image:linear-gradient(#525252 1px,#0000 1px),linear-gradient(90deg,#525252 1px,#0000 1px)}.dark\:from-neutral-900:where(.dark,.dark *){--tw-gradient-from:var(--color-neutral-900);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:to-neutral-950:where(.dark,.dark *){--tw-gradient-to:var(--color-neutral-950);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:text-gray-900:where(.dark,.dark *){color:var(--color-gray-900)}.dark\:text-neutral-50:where(.dark,.dark *){color:var(--color-neutral-50)}.dark\:text-neutral-400:where(.dark,.dark *){color:var(--color-neutral-400)}.dark\:text-neutral-500:where(.dark,.dark *){color:var(--color-neutral-500)}.dark\:text-neutral-600:where(.dark,.dark *){color:var(--color-neutral-600)}.dark\:text-neutral-700:where(.dark,.dark *){color:var(--color-neutral-700)}.dark\:text-sky-400:where(.dark,.dark *){color:var(--color-sky-400)}.dark\:opacity-\[0\.12\]:where(.dark,.dark *){opacity:.12}.dark\:shadow-none:where(.dark,.dark *){--tw-shadow:0 0 #0000;box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.dark\:contrast-90:where(.dark,.dark *){--tw-contrast:contrast(90%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:hue-rotate-180:where(.dark,.dark *){--tw-hue-rotate:hue-rotate(180deg);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:invert:where(.dark,.dark *){--tw-invert:invert(100%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}@media(hover:hover){.dark\:hover\:bg-neutral-800:where(.dark,.dark *):hover{background-color:var(--color-neutral-800)}.dark\:hover\:bg-neutral-800\/50:where(.dark,.dark *):hover{background-color:#26262680}@supports (color:color-mix(in lab,red,red)){.dark\:hover\:bg-neutral-800\/50:where(.dark,.dark *):hover{background-color:color-mix(in oklab,var(--color-neutral-800)50%,transparent)}}.dark\:hover\:text-neutral-50:where(.dark,.dark *):hover{color:var(--color-neutral-50)}}}html{scroll-behavior:smooth}[id]{scroll-margin-top:calc(var(--header-height) + 2rem)}@keyframes fade-in{0%{opacity:0}to{opacity:1}}@keyframes fade-in-up{0%{opacity:0;transform:translateY(20px)}to{opacity:1;transform:translateY(0)}}@keyframes fade-in-down{0%{opacity:0;transform:translateY(-10px)}to{opacity:1;transform:translateY(0)}}@keyframes slide-in-left{0%{opacity:0;transform:translate(-20px)}to{opacity:1;transform:translate(0)}}@keyframes bounce-subtle{0%,to{transform:translateY(0)}50%{transform:translateY(-8px)}}.animate-fade-in{opacity:0;animation:.4s ease-out forwards fade-in}.animate-fade-in-up{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards fade-in-up}.animate-fade-in-down{opacity:0;animation:.25s ease-out forwards fade-in-down}.animate-slide-in-left{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards slide-in-left}.animate-bounce-subtle{animation:2s ease-in-out infinite bounce-subtle}.delay-100{animation-delay:.1s}.delay-200{animation-delay:.2s}.delay-300{animation-delay:.3s}.delay-400{animation-delay:.4s}.delay-500{animation-delay:.5s}.delay-600{animation-delay:.6s}.delay-700{animation-delay:.7s}.delay-800{animation-delay:.8s}@property --tw-translate-x{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-y{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-z{syntax:"*";inherits:false;initial-value:0}@property --tw-rotate-x{syntax:"*";inherits:false}@property --tw-rotate-y{syntax:"*";inherits:false}@property --tw-rotate-z{syntax:"*";inherits:false}@property --tw-skew-x{syntax:"*";inherits:false}@property --tw-skew-y{syntax:"*";inherits:false}@property --tw-space-y-reverse{syntax:"*";inherits:false;initial-value:0}@property --tw-border-style{syntax:"*";inherits:false;initial-value:solid}@property --tw-gradient-position{syntax:"*";inherits:false}@property --tw-gradient-from{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-via{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-to{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-stops{syntax:"*";inherits:false}@property --tw-gradient-via-stops{syntax:"*";inherits:false}@property --tw-gradient-from-position{syntax:"";inherits:false;initial-value:0%}@property --tw-gradient-via-position{syntax:"";inherits:false;initial-value:50%}@property --tw-gradient-to-position{syntax:"";inherits:false;initial-value:100%}@property --tw-leading{syntax:"*";inherits:false}@property --tw-font-weight{syntax:"*";inherits:false}@property --tw-tracking{syntax:"*";inherits:false}@property --tw-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-shadow-color{syntax:"*";inherits:false}@property --tw-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-inset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-shadow-color{syntax:"*";inherits:false}@property --tw-inset-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-ring-color{syntax:"*";inherits:false}@property --tw-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-ring-color{syntax:"*";inherits:false}@property --tw-inset-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-ring-inset{syntax:"*";inherits:false}@property --tw-ring-offset-width{syntax:"";inherits:false;initial-value:0}@property --tw-ring-offset-color{syntax:"*";inherits:false;initial-value:#fff}@property --tw-ring-offset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-blur{syntax:"*";inherits:false}@property --tw-brightness{syntax:"*";inherits:false}@property --tw-contrast{syntax:"*";inherits:false}@property --tw-grayscale{syntax:"*";inherits:false}@property --tw-hue-rotate{syntax:"*";inherits:false}@property --tw-invert{syntax:"*";inherits:false}@property --tw-opacity{syntax:"*";inherits:false}@property --tw-saturate{syntax:"*";inherits:false}@property --tw-sepia{syntax:"*";inherits:false}@property --tw-drop-shadow{syntax:"*";inherits:false}@property --tw-drop-shadow-color{syntax:"*";inherits:false}@property --tw-drop-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-drop-shadow-size{syntax:"*";inherits:false}@property --tw-backdrop-blur{syntax:"*";inherits:false}@property --tw-backdrop-brightness{syntax:"*";inherits:false}@property --tw-backdrop-contrast{syntax:"*";inherits:false}@property --tw-backdrop-grayscale{syntax:"*";inherits:false}@property --tw-backdrop-hue-rotate{syntax:"*";inherits:false}@property --tw-backdrop-invert{syntax:"*";inherits:false}@property --tw-backdrop-opacity{syntax:"*";inherits:false}@property --tw-backdrop-saturate{syntax:"*";inherits:false}@property --tw-backdrop-sepia{syntax:"*";inherits:false}@property --tw-duration{syntax:"*";inherits:false}@property --tw-ease{syntax:"*";inherits:false} diff --git a/docs/index.html b/docs/index.html index ab4d125..0842ffd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -204,52 +204,52 @@ also for long-term maintenance of older version.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. TL;DR +
    2. TL;DR
        -
      1. Do not break the master branch.
      2. -
      3. A release is a git tag.
      4. +
      5. Do not break the master branch.
      6. +
      7. A release is a git tag.
    3. -
    4. The Master Branch +
    5. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST always be in a non-broken state with its test +
      5. The master branch MUST always be in a non-broken state with its test suite passing.
      6. -
      7. The master branch IS NOT guaranteed to always work in production +
      8. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      9. -
      10. The master branch SHOULD always be in a "as near as possibly ready for +
      11. The master branch SHOULD always be in a "as near as possibly ready for release/production" state to reduce any friction with creating a new release.
    6. -
    7. Change Branches +
    8. Change Branches
        -
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +
      2. Each change (feature, bugfix, etc.) MUST be performed on separate branches that SHOULD be referred to as "change branches".
      3. -
      4. All change branches MUST have descriptive names.
      5. -
      6. It is RECOMMENDED that you commit often locally, and that you try and +
      7. All change branches MUST have descriptive names.
      8. +
      9. It is RECOMMENDED that you commit often locally, and that you try and keep the commits reasonably structured to avoid a messy and confusing git history.
      10. -
      11. You SHOULD regularly push your work to the same named branch on the +
      12. You SHOULD regularly push your work to the same named branch on the remote server.
      13. -
      14. You SHOULD create separate change branches for each distinctly different +
      15. You SHOULD create separate change branches for each distinctly different change. You SHOULD NOT include multiple unrelated changes into a single change branch.
      16. -
      17. When a change branch is created, the branch that it is created from +
      18. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target" branch, typically this will be the same as the source branch.
      19. -
      20. Change branches MUST be regularly updated with any changes from their +
      21. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
      22. -
      23. After updating a change branch from its source branch you MUST push the +
      24. After updating a change branch from its source branch you MUST push the change branch to the remote server. Due to the nature of rebasing, you will be required to do a force push, and you MUST use the "--force-with-lease" git push option when doing so instead of the regular "--force".
      25. -
      26. If there is a truly valid technical reason to not use rebase when +
      27. If there is a truly valid technical reason to not use rebase when updating change branches, then you can update change branches via merge instead of rebase. The decision to use merge MUST only be taken after all possible options to use rebase have been tried and failed. People not @@ -258,170 +258,170 @@ you do decide to use merge instead of rebase, you MUST NOT use a mixture of both methods, pick one and stick to it.
    9. -
    10. Pull Requests +
    11. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a "pull +
      2. To merge a change branch into its merge target, you MUST open a "pull request" (or equivalent).
      3. -
      4. The purpose of a pull request is to allow others to review your changes +
      5. The purpose of a pull request is to allow others to review your changes and give feedback. You can then fix any issues, complaints, and more that might arise, and then let people review again.
      6. -
      7. Before creating a pull request, it is RECOMMENDED that you consider the +
      8. Before creating a pull request, it is RECOMMENDED that you consider the state of your change branch's commit history. If it is messy and confusing, it might be a good idea to rebase your branch with "git rebase -i" to present a cleaner and easier to follow commit history for your reviewers.
      9. -
      10. A pull request MUST only be merged when the change branch is up-to-date +
      11. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      12. -
      13. To get feedback, help, or generally just discuss a change branch with +
      14. To get feedback, help, or generally just discuss a change branch with others, it is RECOMMENDED you create a pull request and discuss the changes with others there. This leaves a clear and visible history of how, when, and why the code looks and behaves the way it does.
    12. -
    13. Versioning +
    14. Versioning
        -
      1. A "version string" is a typically mostly numeric string that identifies a +
      2. A "version string" is a typically mostly numeric string that identifies a specific version of a project. The version string itself MUST NOT have a "v" prefix, but the version string can be displayed with a "v" prefix to indicate it is a version that is being referred to.
      3. -
      4. The source of truth for a project's version MUST be a git tag with a name +
      5. The source of truth for a project's version MUST be a git tag with a name based on the version string. This kind of tag MUST be referred to as a "release tag".
      6. -
      7. It is OPTIONAL, but RECOMMENDED to also keep the version string +
      8. It is OPTIONAL, but RECOMMENDED to also keep the version string hard-coded somewhere in the project code-base.
      9. -
      10. If you hard-code the version string into the code-base, it is RECOMMENDED +
      11. If you hard-code the version string into the code-base, it is RECOMMENDED that you do so in a file called "VERSION" located in the root of the project. But be mindful of the conventions of your programming language and community when choosing if, where and how to hard-code the version string.
      12. -
      13. If you are using a "VERSION" file in the root of the project, this file +
      14. If you are using a "VERSION" file in the root of the project, this file MUST only contain the exact version string, meaning it MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
      15. -
      16. It is OPTIONAL, but RECOMMENDED that that the version string follows +
      17. It is OPTIONAL, but RECOMMENDED that that the version string follows Semantic Versioning (http://semver.org/).
    15. -
    16. Releases +
    17. Releases
        -
      1. To create a new release, you MUST create a git tag named as the exact +
      2. To create a new release, you MUST create a git tag named as the exact version string of the release. This kind of tag MUST be referred to as a "release tag".
      3. -
      4. The release tag name can OPTIONALLY be prefixed with "v". For example the +
      5. The release tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED that you do not use a "v" prefix. You MUST NOT use a mixture of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      6. -
      7. If the version string is hard-coded into the code-base, you MUST create a +
      8. If the version string is hard-coded into the code-base, you MUST create a "version bump" commit which changes the hard-coded version string of the project.
      9. -
      10. When using version bump commits, the release tag MUST be placed on the +
      11. When using version bump commits, the release tag MUST be placed on the version bump commit.
      12. -
      13. If you are not using a release branch, then the release tag, and if +
      14. If you are not using a release branch, then the release tag, and if relevant the version bump commit, MUST be created directly on the master branch.
      15. -
      16. The version bump commit SHOULD have a commit message title of "Bump +
      17. The version bump commit SHOULD have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message SHOULD read: "Bump version to 2.11.4"
      18. -
      19. It is RECOMMENDED that release tags are lightweight tags, but you can +
      20. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      21. -
      22. If you use annotated release tags, the first line of the annotation +
      23. If you use annotated release tags, the first line of the annotation SHOULD read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation SHOULD read "Release 2.11.4". The second line MUST be blank, and the changelog MUST start on the third line.
    18. -
    19. Short-Term Release Branches +
    20. Short-Term Release Branches
        -
      1. Any branch that has a name starting with "release-" SHOULD be referred to +
      2. Any branch that has a name starting with "release-" SHOULD be referred to as a "release branch".
      3. -
      4. Any release branch which has a name ending with a specific version +
      5. Any release branch which has a name ending with a specific version string, MUST be referred to as a "short-term release branch".
      6. -
      7. Use of short-term release branches are OPTIONAL, and intended to be used +
      8. Use of short-term release branches are OPTIONAL, and intended to be used to create a specific versioned release.
      9. -
      10. A short-term release branch is RECOMMENDED if there is a lengthy +
      11. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
      12. -
      13. Short-term release branches MUST have a name of "release-VERSION". For +
      14. Short-term release branches MUST have a name of "release-VERSION". For example for version "2.11.4" the release branch name MUST be "release-2.11.4".
      15. -
      16. When using a short-term release branch to create a release, the release +
      17. When using a short-term release branch to create a release, the release tag and if used, version bump commit, MUST be placed directly on the short-term release branch itself.
      18. -
      19. Only very minor changes should be performed on a short-term release +
      20. Only very minor changes should be performed on a short-term release branch directly. Any larger changes SHOULD be done in the master branch, and SHOULD be pulled into the release branch by rebasing it on top of the master branch the same way a change branch pulls in updates from its source branch.
      21. -
      22. After a release tag has been created, the release branch MUST be merged +
      23. After a release tag has been created, the release branch MUST be merged back into its source branch and then deleted. Typically the source branch will be the master branch.
    21. -
    22. Long-term Release Branches +
    23. Long-term Release Branches
        -
      1. Any release branch which has a name ending with a non-specific version +
      2. Any release branch which has a name ending with a non-specific version string, MUST be referred to as a "long-term release branch". For example "release-2.11" is a long-term release branch, while "release-2.11.4" is a short-term release branch.
      3. -
      4. Use of long-term release branches are OPTIONAL, and intended for work on +
      5. Use of long-term release branches are OPTIONAL, and intended for work on versions which are not currently part of the master branch. Typically this is useful when you need to create a new maintenance release for a older version.
      6. -
      7. A long-term release branch MUST have a name with a non-specific version +
      8. A long-term release branch MUST have a name with a non-specific version number. For example a long-term release branch for creating new 2.9.x releases MUST be named "release-2.9".
      9. -
      10. Long-term release branches for maintenance releases of older versions +
      11. Long-term release branches for maintenance releases of older versions MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is "2.9.7". Create a new branch called "release-2.9" from the "2.9.7" release tag. The security fix release will then end up being version "2.9.8".
      12. -
      13. To create a new release from a long-term release branch, you MUST follow +
      14. To create a new release from a long-term release branch, you MUST follow the same process as a release from the master branch, except the long-term release branch takes the place of the master branch.
      15. -
      16. A long-term release branch should be treated with the same respect as the +
      17. A long-term release branch should be treated with the same respect as the master branch. It is effectively the master branch for the release series in question. Meaning it MUST always be in a non-broken state, MUST NOT be force pushed to, etc.
    24. -
    25. Bug Fixes & Rollback +
    26. Bug Fixes & Rollback
        -
      1. You MUST NOT under any circumstances force push to the master branch or +
      2. You MUST NOT under any circumstances force push to the master branch or to long-term release branches.
      3. -
      4. If a change branch which has been merged into the master branch is found +
      5. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
      6. -
      7. If a change branch is wrongfully merged into master, or for any other +
      8. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
    27. -
    28. Git Best Practices +
    29. Git Best Practices
        -
      1. All commit messages SHOULD follow the Commit Guidelines and format from +
      2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
      3. -
      4. You SHOULD never blindly commit all changes with "git commit -a". It is +
      5. You SHOULD never blindly commit all changes with "git commit -a". It is RECOMMENDED you use "git add -i" or "git add -p" to add individual changes to the staging area so you are fully aware of what you are committing.
      6. -
      7. You SHOULD always use "--force-with-lease" when doing a force push. The +
      8. You SHOULD always use "--force-with-lease" when doing a force push. The regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
      9. -
      10. You SHOULD understand and be comfortable with +
      11. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      12. -
      13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
      14. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
      15. -
      16. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
      17. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with diff --git a/docs/spec/1.0.0-rc.1/index.html b/docs/spec/1.0.0-rc.1/index.html index 3ac9263..fd593d0 100644 --- a/docs/spec/1.0.0-rc.1/index.html +++ b/docs/spec/1.0.0-rc.1/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must always have passing tests, is considered bleeding edge, and must be named master.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -198,136 +198,136 @@ branch.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. The Master Branch +
    2. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST be considered bleeding edge.
      5. -
      6. The master branch MUST always be in a non-broken state with its test +
      7. The master branch MUST be considered bleeding edge.
      8. +
      9. The master branch MUST always be in a non-broken state with its test suite passing.
      10. -
      11. The master branch SHOULD always be in a "as near as possible ready for +
      12. The master branch SHOULD always be in a "as near as possible ready for release/production" state to reduce the friction of creating a new release.
    3. -
    4. Changes +
    5. Changes
        -
      1. Changes MUST be performed on a separate branch that SHOULD be referred to +
      2. Changes MUST be performed on a separate branch that SHOULD be referred to as a "change branch". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
      3. -
      4. When a change branch is created, the branch that it is created from +
      5. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target branch", typically this will be the same as the source branch.
      6. -
      7. Change branches MUST be regularly updated with any changes from their +
      8. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch. To be clear you MUST NOT merge a source branch into a change branch.
      9. -
      10. After rebasing a change branch on top of its source branch you MUST push +
      11. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you do a force push, and you SHOULD use the "--force-with-lease" git push option.
      12. -
      13. To merge a change branch into its merge target branch, you MUST open a +
      14. To merge a change branch into its merge target branch, you MUST open a "pull request" (or equivalent) so others can review and approve your changes.
      15. -
      16. A pull request MUST only be merged when the change branch is up-to-date +
      17. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      18. -
      19. To get feedback, help, or generally just discuss a change branch with +
      20. To get feedback, help, or generally just discuss a change branch with others, it is RECOMMENDED you do this by creating a pull request and discuss the changes with others there.
    6. -
    7. Git Best Practices +
    8. Git Best Practices
        -
      1. All commit messages SHOULD follow the Commit Guidelines and format from +
      2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
      3. -
      4. You SHOULD always use "--force-with-lease" when doing a force push. The +
      5. You SHOULD always use "--force-with-lease" when doing a force push. The plain "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
      6. -
      7. You SHOULD understand and be comfortable with +
      8. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      9. -
      10. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
      11. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
      12. -
      13. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
      14. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
    9. -
    10. Versioning +
    11. Versioning
        -
      1. The project MUST have its version hard-coded somewhere in the +
      2. The project MUST have its version hard-coded somewhere in the code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
      3. -
      4. If you are using a "VERSION" file in the root of the project, this MUST +
      5. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      6. -
      7. The version string SHOULD follow the Semantic Versioning +
      8. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, but the version string MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
    12. -
    13. Releases +
    14. Releases
        -
      1. To create a new release, you MUST create a "version bump" commit directly +
      2. To create a new release, you MUST create a "version bump" commit directly on the master branch which changes the hard-coded version value of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
      3. -
      4. A version bump commit MUST have a commit message title of "Bump version +
      5. A version bump commit MUST have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message MUST read: "Bump version to 2.11.4"
      6. -
      7. The release tag on the version bump commit MUST be named exactly the same +
      8. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4".
      9. -
      10. It is RECOMMENDED that release tags are lightweight tags, but you can +
      11. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      12. -
      13. If you use annotated release tags, the first line of the annotation MUST +
      14. If you use annotated release tags, the first line of the annotation MUST read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
    15. -
    16. Bug Fixes & Rollback +
    17. Bug Fixes & Rollback
        -
      1. You MUST NOT under any circumstances force push to the master branch.
      2. -
      3. If a change branch which has been merged in to the master branch is found +
      4. You MUST NOT under any circumstances force push to the master branch.
      5. +
      6. If a change branch which has been merged in to the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
      7. -
      8. If a change branch is wrongfully merged in to master, or for any other +
      9. If a change branch is wrongfully merged in to master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
    18. -
    19. Maintenance Releases +
    20. Maintenance Releases
        -
      1. Any branch that has a name starting with "stable-" SHOULD be referred to +
      2. Any branch that has a name starting with "stable-" SHOULD be referred to as a "maintenance branch".
      3. -
      4. Maintenance branches are used for managing new releases of older +
      5. Maintenance branches are used for managing new releases of older versions. Typically this is used to provide security updates for older versions when the master branch has moved on to a point that a new release for the old version cannot be made from the master branch.
      6. -
      7. A "maintenance release" is identical to a regular release, except the +
      8. A "maintenance release" is identical to a regular release, except the version bump commit and the release tag are placed on the maintenance branch instead of on the master branch.
      9. -
      10. A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where +
      11. A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where "X" is the MAJOR version and "Y" is the minor version.
      12. -
      13. A maintenance branch MUST be created from the relevant release tag. For +
      14. A maintenance branch MUST be created from the relevant release tag. For example if there is a security fix for all 2.9.x releases, the latest of which is "2.9.7", we create a new branch called "stable-2.9" off of the "2.9.7" release tag. The security fix release will then end up being version "2.9.8".
      15. -
      16. When working on a maintenance release, the relevant maintenance branch +
      17. When working on a maintenance release, the relevant maintenance branch MUST be thought of as the master branch for that maintenance work.
      18. -
      19. Changes in a maintenance branch SHOULD typically come from work being +
      20. Changes in a maintenance branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle downwards from the master branch. If a change needs to trickle back up into the master branch, that work should have happened against the master diff --git a/docs/spec/1.0.0-rc.2/index.html b/docs/spec/1.0.0-rc.2/index.html index 2ffd09f..69c9585 100644 --- a/docs/spec/1.0.0-rc.2/index.html +++ b/docs/spec/1.0.0-rc.2/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must always have passing tests, is considered bleeding edge, and must be named master.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -193,134 +193,134 @@ also for long-term maintenance of older version.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. The Master Branch +
    2. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST be considered bleeding edge.
      5. -
      6. The master branch MUST always be in a non-broken state with its test +
      7. The master branch MUST be considered bleeding edge.
      8. +
      9. The master branch MUST always be in a non-broken state with its test suite passing.
      10. -
      11. The master branch SHOULD always be in a "as near as possibly ready for +
      12. The master branch SHOULD always be in a "as near as possibly ready for release/production" state to reduce any friction with creating a new release.
    3. -
    4. Change Branches +
    5. Change Branches
        -
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +
      2. Each change (feature, bugfix, etc.) MUST be performed on separate branches that SHOULD be referred to as "change branches". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
      3. -
      4. You MUST create separate change branches for each distinctly different +
      5. You MUST create separate change branches for each distinctly different change. You MUST NOT include multiple unrelated changes into a single change branch.
      6. -
      7. When a change branch is created, the branch that it is created from +
      8. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target" branch, typically this will be the same as the source branch.
      9. -
      10. Change branches MUST be regularly updated with any changes from their +
      11. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
      12. -
      13. After rebasing a change branch on top of its source branch you MUST push +
      14. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you to do a force push, and you SHOULD use the "--force-with-lease" git push option.
    6. -
    7. Pull Requests +
    8. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a "pull +
      2. To merge a change branch into its merge target, you MUST open a "pull request" (or equivalent) so others can review and approve your changes.
      3. -
      4. A pull request MUST only be merged when the change branch is up-to-date +
      5. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      6. -
      7. To get feedback, help, or generally just discuss a change branch with +
      8. To get feedback, help, or generally just discuss a change branch with others, the RECOMMENDED way to do so is by creating a pull request and discuss the changes with others there.
    9. -
    10. Versioning +
    11. Versioning
        -
      1. The project MUST have its version hard-coded somewhere in the +
      2. The project MUST have its version hard-coded somewhere in the code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
      3. -
      4. If you are using a "VERSION" file in the root of the project, this MUST +
      5. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      6. -
      7. The version string SHOULD follow the Semantic Versioning +
      8. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, but the version string MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
    12. -
    13. Releases +
    14. Releases
        -
      1. To create a new release, you MUST create a "version bump" commit which +
      2. To create a new release, you MUST create a "version bump" commit which changes the hard-coded version string of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
      3. -
      4. If you are not using a release branch, then the version bump commit MUST +
      5. If you are not using a release branch, then the version bump commit MUST be created directly on the master branch.
      6. -
      7. The version bump commit MUST have a commit message title of "Bump version +
      8. The version bump commit MUST have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message MUST read: "Bump version to 2.11.4"
      9. -
      10. The release tag on the version bump commit MUST be named exactly the same +
      11. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4". You MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      12. -
      13. It is RECOMMENDED that release tags are lightweight tags, but you can +
      14. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      15. -
      16. If you use annotated release tags, the first line of the annotation MUST +
      17. If you use annotated release tags, the first line of the annotation MUST read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
    15. -
    16. Release Branches +
    17. Release Branches
        -
      1. Any branch that has a name starting with "release-" SHOULD be referred to +
      2. Any branch that has a name starting with "release-" SHOULD be referred to as a "release branch".
      3. -
      4. Use of release branches is OPTIONAL.
      5. -
      6. Changes in a release branch SHOULD typically come from work being +
      7. Use of release branches is OPTIONAL.
      8. +
      9. Changes in a release branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle downwards from the master branch. If a change needs to trickle back up into the master branch, that work should have happened against the master branch in the first place. One exception to this is version bump commits.
      10. -
      11. There are two types of release branches; short-term, and long-term.
      12. -
      13. Short-Term Release Branches +
      14. There are two types of release branches; short-term, and long-term.
      15. +
      16. Short-Term Release Branches
          -
        1. Used for creating a specific versioned release.
        2. -
        3. A short-term release branch is RECOMMENDED if there is a lengthy +
        4. Used for creating a specific versioned release.
        5. +
        6. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
        7. -
        8. MUST have a name of "release-VERSION". For example for version +
        9. MUST have a name of "release-VERSION". For example for version "2.11.4" the release branch name MUST be "release-2.11.4".
        10. -
        11. When using a short-term release branch, the version bump commit and +
        12. When using a short-term release branch, the version bump commit and release tag MUST be made directly on the release branch itself.
        13. -
        14. Only very minor changes should be performed on a short-term release +
        15. Only very minor changes should be performed on a short-term release branch directly. Any larger changes SHOULD be done in the master branch, and SHOULD be pulled into the release branch by rebasing it on top of the master branch the same way a change branch pulls in updates from its source branch.
        16. -
        17. After the version bump commit and release tag have been created, the +
        18. After the version bump commit and release tag have been created, the release branch MUST be merged back into its source branch and then deleted. Typically the source branch will be the master branch.
      17. -
      18. Long-Term Release Branches +
      19. Long-Term Release Branches
          -
        1. Used for work on versions which are not currently part of the master +
        2. Used for work on versions which are not currently part of the master branch. Typically this is useful when you need to create a new maintenance release for a older version.
        3. -
        4. The branch name MUST have a non-specific version number. For example +
        5. The branch name MUST have a non-specific version number. For example a long-term release branch for creating new 2.9.x releases would be named "release-2.9".
        6. -
        7. To create a new release from a long-term release branch, you MUST +
        8. To create a new release from a long-term release branch, you MUST create a version bump commit and release tag directly on the release branch.
        9. -
        10. A long-term release branch MUST be created from the relevant release +
        11. A long-term release branch MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" @@ -330,38 +330,38 @@ release tag. The security fix release will then end up being version
      20. -
      21. Bug Fixes & Rollback +
      22. Bug Fixes & Rollback
          -
        1. You MUST NOT under any circumstances force push to the master branch.
        2. -
        3. If a change branch which has been merged into the master branch is found +
        4. You MUST NOT under any circumstances force push to the master branch.
        5. +
        6. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
        7. -
        8. If a change branch is wrongfully merged into master, or for any other +
        9. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
      23. -
      24. Git Best Practices +
      25. Git Best Practices
          -
        1. All commit messages SHOULD follow the Commit Guidelines and format from +
        2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
        3. -
        4. You SHOULD never blindly commit all changes with "git commit -a". It is +
        5. You SHOULD never blindly commit all changes with "git commit -a". It is RECOMMENDED you use "git add -i" to add individual changes to the staging area so you are fully aware of what you are committing.
        6. -
        7. You SHOULD always use "--force-with-lease" when doing a force push. The +
        8. You SHOULD always use "--force-with-lease" when doing a force push. The regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
        9. -
        10. You SHOULD understand and be comfortable with +
        11. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
        12. -
        13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
        14. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
        15. -
        16. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
        17. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with diff --git a/docs/spec/1.0.0-rc.3/index.html b/docs/spec/1.0.0-rc.3/index.html index 7da8020..a284cb0 100644 --- a/docs/spec/1.0.0-rc.3/index.html +++ b/docs/spec/1.0.0-rc.3/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -194,142 +194,142 @@ also for long-term maintenance of older version.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. TL;DR +
    2. TL;DR
        -
      1. Don't break the master branch.
      2. -
      3. A release is a git tag.
      4. +
      5. Don't break the master branch.
      6. +
      7. A release is a git tag.
    3. -
    4. The Master Branch +
    5. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST always be in a non-broken state with its test +
      5. The master branch MUST always be in a non-broken state with its test suite passing.
      6. -
      7. The master branch IS NOT guaranteed to always work in production +
      8. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      9. -
      10. The master branch SHOULD always be in a "as near as possibly ready for +
      11. The master branch SHOULD always be in a "as near as possibly ready for release/production" state to reduce any friction with creating a new release.
    6. -
    7. Change Branches +
    8. Change Branches
        -
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +
      2. Each change (feature, bugfix, etc.) MUST be performed on separate branches that SHOULD be referred to as "change branches". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
      3. -
      4. You MUST create separate change branches for each distinctly different +
      5. You MUST create separate change branches for each distinctly different change. You MUST NOT include multiple unrelated changes into a single change branch.
      6. -
      7. When a change branch is created, the branch that it is created from +
      8. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target" branch, typically this will be the same as the source branch.
      9. -
      10. Change branches MUST be regularly updated with any changes from their +
      11. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
      12. -
      13. After rebasing a change branch on top of its source branch you MUST push +
      14. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you to do a force push, and you SHOULD use the "--force-with-lease" git push option.
    9. -
    10. Pull Requests +
    11. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a "pull +
      2. To merge a change branch into its merge target, you MUST open a "pull request" (or equivalent) so others can review and approve your changes.
      3. -
      4. A pull request MUST only be merged when the change branch is up-to-date +
      5. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      6. -
      7. To get feedback, help, or generally just discuss a change branch with +
      8. To get feedback, help, or generally just discuss a change branch with others, the RECOMMENDED way to do so is by creating a pull request and discuss the changes with others there.
    12. -
    13. Versioning +
    14. Versioning
        -
      1. The project MUST have its version hard-coded somewhere in the +
      2. The project MUST have its version hard-coded somewhere in the code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
      3. -
      4. If you are using a "VERSION" file in the root of the project, this MUST +
      5. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      6. -
      7. The version string SHOULD follow the Semantic Versioning +
      8. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, but the version string MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
    15. -
    16. Releases +
    17. Releases
        -
      1. To create a new release, you MUST create a "version bump" commit which +
      2. To create a new release, you MUST create a "version bump" commit which changes the hard-coded version string of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
      3. -
      4. If you are not using a release branch, then the version bump commit MUST +
      5. If you are not using a release branch, then the version bump commit MUST be created directly on the master branch.
      6. -
      7. The version bump commit MUST have a commit message title of "Bump version +
      8. The version bump commit MUST have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message MUST read: "Bump version to 2.11.4"
      9. -
      10. The release tag on the version bump commit MUST be named exactly the same +
      11. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4". You MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      12. -
      13. It is RECOMMENDED that release tags are lightweight tags, but you can +
      14. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      15. -
      16. If you use annotated release tags, the first line of the annotation MUST +
      17. If you use annotated release tags, the first line of the annotation MUST read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
    18. -
    19. Release Branches +
    20. Release Branches
        -
      1. Any branch that has a name starting with "release-" SHOULD be referred to +
      2. Any branch that has a name starting with "release-" SHOULD be referred to as a "release branch".
      3. -
      4. Use of release branches is OPTIONAL.
      5. -
      6. Changes in a release branch SHOULD typically come from work being +
      7. Use of release branches is OPTIONAL.
      8. +
      9. Changes in a release branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle downwards from the master branch. If a change needs to trickle back up into the master branch, that work should have happened against the master branch in the first place. One exception to this is version bump commits.
      10. -
      11. There are two types of release branches; short-term, and long-term.
      12. -
      13. Short-Term Release Branches +
      14. There are two types of release branches; short-term, and long-term.
      15. +
      16. Short-Term Release Branches
          -
        1. Used for creating a specific versioned release.
        2. -
        3. A short-term release branch is RECOMMENDED if there is a lengthy +
        4. Used for creating a specific versioned release.
        5. +
        6. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
        7. -
        8. MUST have a name of "release-VERSION". For example for version +
        9. MUST have a name of "release-VERSION". For example for version "2.11.4" the release branch name MUST be "release-2.11.4".
        10. -
        11. When using a short-term release branch, the version bump commit and +
        12. When using a short-term release branch, the version bump commit and release tag MUST be made directly on the release branch itself.
        13. -
        14. Only very minor changes should be performed on a short-term release +
        15. Only very minor changes should be performed on a short-term release branch directly. Any larger changes SHOULD be done in the master branch, and SHOULD be pulled into the release branch by rebasing it on top of the master branch the same way a change branch pulls in updates from its source branch.
        16. -
        17. After the version bump commit and release tag have been created, the +
        18. After the version bump commit and release tag have been created, the release branch MUST be merged back into its source branch and then deleted. Typically the source branch will be the master branch.
      17. -
      18. Long-Term Release Branches +
      19. Long-Term Release Branches
          -
        1. Used for work on versions which are not currently part of the master +
        2. Used for work on versions which are not currently part of the master branch. Typically this is useful when you need to create a new maintenance release for a older version.
        3. -
        4. The branch name MUST have a non-specific version number. For example +
        5. The branch name MUST have a non-specific version number. For example a long-term release branch for creating new 2.9.x releases would be named "release-2.9".
        6. -
        7. To create a new release from a long-term release branch, you MUST +
        8. To create a new release from a long-term release branch, you MUST create a version bump commit and release tag directly on the release branch.
        9. -
        10. A long-term release branch MUST be created from the relevant release +
        11. A long-term release branch MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" @@ -339,38 +339,38 @@ release tag. The security fix release will then end up being version
      20. -
      21. Bug Fixes & Rollback +
      22. Bug Fixes & Rollback
          -
        1. You MUST NOT under any circumstances force push to the master branch.
        2. -
        3. If a change branch which has been merged into the master branch is found +
        4. You MUST NOT under any circumstances force push to the master branch.
        5. +
        6. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
        7. -
        8. If a change branch is wrongfully merged into master, or for any other +
        9. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
      23. -
      24. Git Best Practices +
      25. Git Best Practices
          -
        1. All commit messages SHOULD follow the Commit Guidelines and format from +
        2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
        3. -
        4. You SHOULD never blindly commit all changes with "git commit -a". It is +
        5. You SHOULD never blindly commit all changes with "git commit -a". It is RECOMMENDED you use "git add -i" to add individual changes to the staging area so you are fully aware of what you are committing.
        6. -
        7. You SHOULD always use "--force-with-lease" when doing a force push. The +
        8. You SHOULD always use "--force-with-lease" when doing a force push. The regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
        9. -
        10. You SHOULD understand and be comfortable with +
        11. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
        12. -
        13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
        14. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
        15. -
        16. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
        17. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with diff --git a/docs/spec/1.0.0-rc.4/index.html b/docs/spec/1.0.0-rc.4/index.html index 2cc575c..96fb254 100644 --- a/docs/spec/1.0.0-rc.4/index.html +++ b/docs/spec/1.0.0-rc.4/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -193,52 +193,52 @@ also for long-term maintenance of older version.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. TL;DR +
    2. TL;DR
        -
      1. Don't break the master branch.
      2. -
      3. A release is a git tag.
      4. +
      5. Don't break the master branch.
      6. +
      7. A release is a git tag.
    3. -
    4. The Master Branch +
    5. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST always be in a non-broken state with its test +
      5. The master branch MUST always be in a non-broken state with its test suite passing.
      6. -
      7. The master branch IS NOT guaranteed to always work in production +
      8. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      9. -
      10. The master branch SHOULD always be in a "as near as possibly ready for +
      11. The master branch SHOULD always be in a "as near as possibly ready for release/production" state to reduce any friction with creating a new release.
    6. -
    7. Change Branches +
    8. Change Branches
        -
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +
      2. Each change (feature, bugfix, etc.) MUST be performed on separate branches that SHOULD be referred to as "change branches".
      3. -
      4. All change branches MUST have descriptive names.
      5. -
      6. It is RECOMMENDED that you commit often locally, and that you try and +
      7. All change branches MUST have descriptive names.
      8. +
      9. It is RECOMMENDED that you commit often locally, and that you try and keep the commits reasonably structured to avoid a messy and confusing git history.
      10. -
      11. You SHOULD regularly push your work to the same named branch on the +
      12. You SHOULD regularly push your work to the same named branch on the remote server.
      13. -
      14. You SHOULD create separate change branches for each distinctly different +
      15. You SHOULD create separate change branches for each distinctly different change. You SHOULD NOT include multiple unrelated changes into a single change branch.
      16. -
      17. When a change branch is created, the branch that it is created from +
      18. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target" branch, typically this will be the same as the source branch.
      19. -
      20. Change branches MUST be regularly updated with any changes from their +
      21. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
      22. -
      23. After updating a change branch from its source branch you MUST push the +
      24. After updating a change branch from its source branch you MUST push the change branch to the remote server. Due to the nature of rebasing, you will be required to do a force push, and you MUST use the "--force-with-lease" git push option when doing so instead of the regular "--force".
      25. -
      26. If there is a truly valid technical reason to not use rebase when +
      27. If there is a truly valid technical reason to not use rebase when updating change branches, then you can update change branches via merge instead of rebase. The decision to use merge MUST only be taken after all possible options to use rebase have been tried and failed. People not @@ -247,169 +247,169 @@ you do decide to use merge instead of rebase, you MUST NOT use a mixture of both methods, pick one and stick to it.
    9. -
    10. Pull Requests +
    11. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a "pull +
      2. To merge a change branch into its merge target, you MUST open a "pull request" (or equivalent).
      3. -
      4. The purpose of a pull request is to allow others to review your changes +
      5. The purpose of a pull request is to allow others to review your changes and give feedback. You can then fix any issues, complaints, and more that might arise, and then let people review again.
      6. -
      7. Before creating a pull request, it is RECOMMENDED that you consider the +
      8. Before creating a pull request, it is RECOMMENDED that you consider the state of your change branch's commit history. If it is messy and confusing, it might be a good idea to rebase your branch with "git rebase -i" to present a cleaner and easier to follow commit history for your reviewers.
      9. -
      10. A pull request MUST only be merged when the change branch is up-to-date +
      11. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      12. -
      13. To get feedback, help, or generally just discuss a change branch with +
      14. To get feedback, help, or generally just discuss a change branch with others, the RECOMMENDED way to do so is by creating a pull request and discuss the changes with others there.
    12. -
    13. Versioning +
    14. Versioning
        -
      1. A "version string" is a typically mostly numeric string that identifies a +
      2. A "version string" is a typically mostly numeric string that identifies a specific version of a project. The version string itself MUST NOT have a "v" prefix, but the version string can be displayed with a "v" prefix to indicate it is a version that is being referred to.
      3. -
      4. The source of truth for a project's version MUST be a git tag with a name +
      5. The source of truth for a project's version MUST be a git tag with a name based on the version string. This kind of tag MUST be referred to as a "release tag".
      6. -
      7. It is OPTIONAL, but RECOMMENDED to also keep the version string +
      8. It is OPTIONAL, but RECOMMENDED to also keep the version string hard-coded somewhere in the project code-base.
      9. -
      10. If you hard-code the version string into the code-base, it is RECOMMENDED +
      11. If you hard-code the version string into the code-base, it is RECOMMENDED that you do so in a file called "VERSION" located in the root of the project. But be mindful of the conventions of your programming language and community when choosing if, where and how to hard-code the version string.
      12. -
      13. If you are using a "VERSION" file in the root of the project, this file +
      14. If you are using a "VERSION" file in the root of the project, this file MUST only contain the exact version string, meaning it MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
      15. -
      16. It is OPTIONAL, but RECOMMENDED that that the version string follows +
      17. It is OPTIONAL, but RECOMMENDED that that the version string follows Semantic Versioning (http://semver.org/).
    15. -
    16. Releases +
    17. Releases
        -
      1. To create a new release, you MUST create a git tag named as the exact +
      2. To create a new release, you MUST create a git tag named as the exact version string of the release. This kind of tag MUST be referred to as a "release tag".
      3. -
      4. The release tag name can OPTIONALLY be prefixed with "v". For example the +
      5. The release tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED that you do not use a "v" prefix. You MUST NOT use a mixture of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      6. -
      7. If the version string is hard-coded into the code-base, you MUST create a +
      8. If the version string is hard-coded into the code-base, you MUST create a "version bump" commit which changes the hard-coded version string of the project.
      9. -
      10. When using version bump commits, the release tag MUST be placed on the +
      11. When using version bump commits, the release tag MUST be placed on the version bump commit.
      12. -
      13. If you are not using a release branch, then the release tag, and if +
      14. If you are not using a release branch, then the release tag, and if relevant the version bump commit, MUST be created directly on the master branch.
      15. -
      16. The version bump commit SHOULD have a commit message title of "Bump +
      17. The version bump commit SHOULD have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message SHOULD read: "Bump version to 2.11.4"
      18. -
      19. It is RECOMMENDED that release tags are lightweight tags, but you can +
      20. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      21. -
      22. If you use annotated release tags, the first line of the annotation +
      23. If you use annotated release tags, the first line of the annotation SHOULD read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation SHOULD read "Release 2.11.4". The second line MUST be blank, and the changelog MUST start on the third line.
    18. -
    19. Short-Term Release Branches +
    20. Short-Term Release Branches
        -
      1. Any branch that has a name starting with "release-" SHOULD be referred to +
      2. Any branch that has a name starting with "release-" SHOULD be referred to as a "release branch".
      3. -
      4. Any release branch which has a name ending with a specific version +
      5. Any release branch which has a name ending with a specific version string, MUST be referred to as a "short-term release branch".
      6. -
      7. Use of short-term release branches are OPTIONAL, and intended to be used +
      8. Use of short-term release branches are OPTIONAL, and intended to be used to create a specific versioned release.
      9. -
      10. A short-term release branch is RECOMMENDED if there is a lengthy +
      11. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
      12. -
      13. Short-term release branches MUST have a name of "release-VERSION". For +
      14. Short-term release branches MUST have a name of "release-VERSION". For example for version "2.11.4" the release branch name MUST be "release-2.11.4".
      15. -
      16. When using a short-term release branch to create a release, the release +
      17. When using a short-term release branch to create a release, the release tag and if used, version bump commit, MUST be placed directly on the short-term release branch itself.
      18. -
      19. Only very minor changes should be performed on a short-term release +
      20. Only very minor changes should be performed on a short-term release branch directly. Any larger changes SHOULD be done in the master branch, and SHOULD be pulled into the release branch by rebasing it on top of the master branch the same way a change branch pulls in updates from its source branch.
      21. -
      22. After a release tag has been created, the release branch MUST be merged +
      23. After a release tag has been created, the release branch MUST be merged back into its source branch and then deleted. Typically the source branch will be the master branch.
    21. -
    22. Long-term Release Branches +
    23. Long-term Release Branches
        -
      1. Any release branch which has a name ending with a non-specific version +
      2. Any release branch which has a name ending with a non-specific version string, MUST be referred to as a "long-term release branch". For example "release-2.11" is a long-term release branch, while "release-2.11.4" is a short-term release branch.
      3. -
      4. Use of long-term release branches are OPTIONAL, and intended for work on +
      5. Use of long-term release branches are OPTIONAL, and intended for work on versions which are not currently part of the master branch. Typically this is useful when you need to create a new maintenance release for a older version.
      6. -
      7. A long-term release branch MUST have a name with a non-specific version +
      8. A long-term release branch MUST have a name with a non-specific version number. For example a long-term release branch for creating new 2.9.x releases MUST be named "release-2.9".
      9. -
      10. Long-term release branches for maintenance releases of older versions +
      11. Long-term release branches for maintenance releases of older versions MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" release tag. The security fix release will then end up being version "2.9.8".
      12. -
      13. To create a new release from a long-term release branch, you MUST follow +
      14. To create a new release from a long-term release branch, you MUST follow the same process as a release from the master branch, except the long-term release branch takes the place of the master branch.
      15. -
      16. A long-term release branch should be treated with the same respect as the +
      17. A long-term release branch should be treated with the same respect as the master branch. It is effectively the master branch for the release series in question. Meaning it MUST always be in a non-broken state, MUST NOT be force pushed to, etc.
    24. -
    25. Bug Fixes & Rollback +
    26. Bug Fixes & Rollback
        -
      1. You MUST NOT under any circumstances force push to the master branch or +
      2. You MUST NOT under any circumstances force push to the master branch or to long-term release branches.
      3. -
      4. If a change branch which has been merged into the master branch is found +
      5. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
      6. -
      7. If a change branch is wrongfully merged into master, or for any other +
      8. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
    27. -
    28. Git Best Practices +
    29. Git Best Practices
        -
      1. All commit messages SHOULD follow the Commit Guidelines and format from +
      2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
      3. -
      4. You SHOULD never blindly commit all changes with "git commit -a". It is +
      5. You SHOULD never blindly commit all changes with "git commit -a". It is RECOMMENDED you use "git add -i" or "git add -p" to add individual changes to the staging area so you are fully aware of what you are committing.
      6. -
      7. You SHOULD always use "--force-with-lease" when doing a force push. The +
      8. You SHOULD always use "--force-with-lease" when doing a force push. The regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
      9. -
      10. You SHOULD understand and be comfortable with +
      11. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      12. -
      13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
      14. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
      15. -
      16. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
      17. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with diff --git a/docs/spec/1.0.0-rc.5/index.html b/docs/spec/1.0.0-rc.5/index.html index c276a48..990be76 100644 --- a/docs/spec/1.0.0-rc.5/index.html +++ b/docs/spec/1.0.0-rc.5/index.html @@ -8,7 +8,7 @@ document.documentElement.classList.add("dark"); } })(); -

Terminology

    +

Terminology

  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -204,52 +204,52 @@ also for long-term maintenance of older version.
  • "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

      -
    1. TL;DR +
    2. TL;DR
        -
      1. Do not break the master branch.
      2. -
      3. A release is a git tag.
      4. +
      5. Do not break the master branch.
      6. +
      7. A release is a git tag.
    3. -
    4. The Master Branch +
    5. The Master Branch
        -
      1. A branch named "master" MUST exist and it MUST be referred to as the +
      2. A branch named "master" MUST exist and it MUST be referred to as the "master branch".
      3. -
      4. The master branch MUST always be in a non-broken state with its test +
      5. The master branch MUST always be in a non-broken state with its test suite passing.
      6. -
      7. The master branch IS NOT guaranteed to always work in production +
      8. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      9. -
      10. The master branch SHOULD always be in a "as near as possibly ready for +
      11. The master branch SHOULD always be in a "as near as possibly ready for release/production" state to reduce any friction with creating a new release.
    6. -
    7. Change Branches +
    8. Change Branches
        -
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +
      2. Each change (feature, bugfix, etc.) MUST be performed on separate branches that SHOULD be referred to as "change branches".
      3. -
      4. All change branches MUST have descriptive names.
      5. -
      6. It is RECOMMENDED that you commit often locally, and that you try and +
      7. All change branches MUST have descriptive names.
      8. +
      9. It is RECOMMENDED that you commit often locally, and that you try and keep the commits reasonably structured to avoid a messy and confusing git history.
      10. -
      11. You SHOULD regularly push your work to the same named branch on the +
      12. You SHOULD regularly push your work to the same named branch on the remote server.
      13. -
      14. You SHOULD create separate change branches for each distinctly different +
      15. You SHOULD create separate change branches for each distinctly different change. You SHOULD NOT include multiple unrelated changes into a single change branch.
      16. -
      17. When a change branch is created, the branch that it is created from +
      18. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also needs a designated "merge target" branch, typically this will be the same as the source branch.
      19. -
      20. Change branches MUST be regularly updated with any changes from their +
      21. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
      22. -
      23. After updating a change branch from its source branch you MUST push the +
      24. After updating a change branch from its source branch you MUST push the change branch to the remote server. Due to the nature of rebasing, you will be required to do a force push, and you MUST use the "--force-with-lease" git push option when doing so instead of the regular "--force".
      25. -
      26. If there is a truly valid technical reason to not use rebase when +
      27. If there is a truly valid technical reason to not use rebase when updating change branches, then you can update change branches via merge instead of rebase. The decision to use merge MUST only be taken after all possible options to use rebase have been tried and failed. People not @@ -258,170 +258,170 @@ you do decide to use merge instead of rebase, you MUST NOT use a mixture of both methods, pick one and stick to it.
    9. -
    10. Pull Requests +
    11. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a "pull +
      2. To merge a change branch into its merge target, you MUST open a "pull request" (or equivalent).
      3. -
      4. The purpose of a pull request is to allow others to review your changes +
      5. The purpose of a pull request is to allow others to review your changes and give feedback. You can then fix any issues, complaints, and more that might arise, and then let people review again.
      6. -
      7. Before creating a pull request, it is RECOMMENDED that you consider the +
      8. Before creating a pull request, it is RECOMMENDED that you consider the state of your change branch's commit history. If it is messy and confusing, it might be a good idea to rebase your branch with "git rebase -i" to present a cleaner and easier to follow commit history for your reviewers.
      9. -
      10. A pull request MUST only be merged when the change branch is up-to-date +
      11. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
      12. -
      13. To get feedback, help, or generally just discuss a change branch with +
      14. To get feedback, help, or generally just discuss a change branch with others, it is RECOMMENDED you create a pull request and discuss the changes with others there. This leaves a clear and visible history of how, when, and why the code looks and behaves the way it does.
    12. -
    13. Versioning +
    14. Versioning
        -
      1. A "version string" is a typically mostly numeric string that identifies a +
      2. A "version string" is a typically mostly numeric string that identifies a specific version of a project. The version string itself MUST NOT have a "v" prefix, but the version string can be displayed with a "v" prefix to indicate it is a version that is being referred to.
      3. -
      4. The source of truth for a project's version MUST be a git tag with a name +
      5. The source of truth for a project's version MUST be a git tag with a name based on the version string. This kind of tag MUST be referred to as a "release tag".
      6. -
      7. It is OPTIONAL, but RECOMMENDED to also keep the version string +
      8. It is OPTIONAL, but RECOMMENDED to also keep the version string hard-coded somewhere in the project code-base.
      9. -
      10. If you hard-code the version string into the code-base, it is RECOMMENDED +
      11. If you hard-code the version string into the code-base, it is RECOMMENDED that you do so in a file called "VERSION" located in the root of the project. But be mindful of the conventions of your programming language and community when choosing if, where and how to hard-code the version string.
      12. -
      13. If you are using a "VERSION" file in the root of the project, this file +
      14. If you are using a "VERSION" file in the root of the project, this file MUST only contain the exact version string, meaning it MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
      15. -
      16. It is OPTIONAL, but RECOMMENDED that that the version string follows +
      17. It is OPTIONAL, but RECOMMENDED that that the version string follows Semantic Versioning (http://semver.org/).
    15. -
    16. Releases +
    17. Releases
        -
      1. To create a new release, you MUST create a git tag named as the exact +
      2. To create a new release, you MUST create a git tag named as the exact version string of the release. This kind of tag MUST be referred to as a "release tag".
      3. -
      4. The release tag name can OPTIONALLY be prefixed with "v". For example the +
      5. The release tag name can OPTIONALLY be prefixed with "v". For example the tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED that you do not use a "v" prefix. You MUST NOT use a mixture of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      6. -
      7. If the version string is hard-coded into the code-base, you MUST create a +
      8. If the version string is hard-coded into the code-base, you MUST create a "version bump" commit which changes the hard-coded version string of the project.
      9. -
      10. When using version bump commits, the release tag MUST be placed on the +
      11. When using version bump commits, the release tag MUST be placed on the version bump commit.
      12. -
      13. If you are not using a release branch, then the release tag, and if +
      14. If you are not using a release branch, then the release tag, and if relevant the version bump commit, MUST be created directly on the master branch.
      15. -
      16. The version bump commit SHOULD have a commit message title of "Bump +
      17. The version bump commit SHOULD have a commit message title of "Bump version to VERSION". For example, if the new version string is "2.11.4", the first line of the commit message SHOULD read: "Bump version to 2.11.4"
      18. -
      19. It is RECOMMENDED that release tags are lightweight tags, but you can +
      20. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      21. -
      22. If you use annotated release tags, the first line of the annotation +
      23. If you use annotated release tags, the first line of the annotation SHOULD read "Release VERSION". For example for version "2.11.4" the first line of the tag annotation SHOULD read "Release 2.11.4". The second line MUST be blank, and the changelog MUST start on the third line.
    18. -
    19. Short-Term Release Branches +
    20. Short-Term Release Branches
        -
      1. Any branch that has a name starting with "release-" SHOULD be referred to +
      2. Any branch that has a name starting with "release-" SHOULD be referred to as a "release branch".
      3. -
      4. Any release branch which has a name ending with a specific version +
      5. Any release branch which has a name ending with a specific version string, MUST be referred to as a "short-term release branch".
      6. -
      7. Use of short-term release branches are OPTIONAL, and intended to be used +
      8. Use of short-term release branches are OPTIONAL, and intended to be used to create a specific versioned release.
      9. -
      10. A short-term release branch is RECOMMENDED if there is a lengthy +
      11. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
      12. -
      13. Short-term release branches MUST have a name of "release-VERSION". For +
      14. Short-term release branches MUST have a name of "release-VERSION". For example for version "2.11.4" the release branch name MUST be "release-2.11.4".
      15. -
      16. When using a short-term release branch to create a release, the release +
      17. When using a short-term release branch to create a release, the release tag and if used, version bump commit, MUST be placed directly on the short-term release branch itself.
      18. -
      19. Only very minor changes should be performed on a short-term release +
      20. Only very minor changes should be performed on a short-term release branch directly. Any larger changes SHOULD be done in the master branch, and SHOULD be pulled into the release branch by rebasing it on top of the master branch the same way a change branch pulls in updates from its source branch.
      21. -
      22. After a release tag has been created, the release branch MUST be merged +
      23. After a release tag has been created, the release branch MUST be merged back into its source branch and then deleted. Typically the source branch will be the master branch.
    21. -
    22. Long-term Release Branches +
    23. Long-term Release Branches
        -
      1. Any release branch which has a name ending with a non-specific version +
      2. Any release branch which has a name ending with a non-specific version string, MUST be referred to as a "long-term release branch". For example "release-2.11" is a long-term release branch, while "release-2.11.4" is a short-term release branch.
      3. -
      4. Use of long-term release branches are OPTIONAL, and intended for work on +
      5. Use of long-term release branches are OPTIONAL, and intended for work on versions which are not currently part of the master branch. Typically this is useful when you need to create a new maintenance release for a older version.
      6. -
      7. A long-term release branch MUST have a name with a non-specific version +
      8. A long-term release branch MUST have a name with a non-specific version number. For example a long-term release branch for creating new 2.9.x releases MUST be named "release-2.9".
      9. -
      10. Long-term release branches for maintenance releases of older versions +
      11. Long-term release branches for maintenance releases of older versions MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is "2.9.7". Create a new branch called "release-2.9" from the "2.9.7" release tag. The security fix release will then end up being version "2.9.8".
      12. -
      13. To create a new release from a long-term release branch, you MUST follow +
      14. To create a new release from a long-term release branch, you MUST follow the same process as a release from the master branch, except the long-term release branch takes the place of the master branch.
      15. -
      16. A long-term release branch should be treated with the same respect as the +
      17. A long-term release branch should be treated with the same respect as the master branch. It is effectively the master branch for the release series in question. Meaning it MUST always be in a non-broken state, MUST NOT be force pushed to, etc.
    24. -
    25. Bug Fixes & Rollback +
    26. Bug Fixes & Rollback
        -
      1. You MUST NOT under any circumstances force push to the master branch or +
      2. You MUST NOT under any circumstances force push to the master branch or to long-term release branches.
      3. -
      4. If a change branch which has been merged into the master branch is found +
      5. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
      6. -
      7. If a change branch is wrongfully merged into master, or for any other +
      8. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
    27. -
    28. Git Best Practices +
    29. Git Best Practices
        -
      1. All commit messages SHOULD follow the Commit Guidelines and format from +
      2. All commit messages SHOULD follow the Commit Guidelines and format from the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
      3. -
      4. You SHOULD never blindly commit all changes with "git commit -a". It is +
      5. You SHOULD never blindly commit all changes with "git commit -a". It is RECOMMENDED you use "git add -i" or "git add -p" to add individual changes to the staging area so you are fully aware of what you are committing.
      6. -
      7. You SHOULD always use "--force-with-lease" when doing a force push. The +
      8. You SHOULD always use "--force-with-lease" when doing a force push. The regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
      9. -
      10. You SHOULD understand and be comfortable with +
      11. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      12. -
      13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +
      14. It is RECOMMENDED that you always do "git pull --rebase" instead of "git pull" to avoid unnecessary merge commits. You can make this the default behavior of "git pull" with "git config --global pull.rebase true".
      15. -
      16. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +
      17. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with diff --git a/src/styles/global.css b/src/styles/global.css index 966643e..ed4dc96 100644 --- a/src/styles/global.css +++ b/src/styles/global.css @@ -149,7 +149,7 @@ html { background-color: theme(colors.neutral.900); } - pre > code { + pre>code { background-color: transparent !important; padding: 0; font-size: 0.875rem; @@ -259,6 +259,7 @@ html { } @keyframes bounce-subtle { + 0%, 100% { transform: translateY(0); @@ -329,6 +330,7 @@ html { /* Component styles */ @layer components { + /* Section container - uses CSS vars, keep here */ .section-container { max-width: calc(var(--content-max-width) + var(--sidebar-width) + 4rem); @@ -393,19 +395,20 @@ html { color: theme(colors.neutral.400); } - /* Nested ordered list counters (spec numbering: 1., 1.1., 1.2.) */ + /* Spec clauses - ordered list with CSS counters and hover anchor links */ .prose-spec ol { padding-left: 2.5rem; counter-reset: item; list-style: none; } - .prose-spec ol > li { + .prose-spec ol>li { counter-increment: item; position: relative; + margin-bottom: 0.5rem; } - .prose-spec ol > li::before { + .prose-spec ol>li::before { content: counters(item, ".") "."; position: absolute; left: -2.5rem; @@ -415,10 +418,50 @@ html { color: theme(colors.slate.400); } - .dark .prose-spec ol > li::before { + .dark .prose-spec ol>li::before { color: theme(colors.neutral.500); } + /* Invisible anchor link that appears on hover */ + .prose-spec .clause-link { + position: absolute; + left: -3.5rem; + top: 0.125rem; + width: 1.25rem; + height: 1.25rem; + display: flex; + align-items: center; + justify-content: center; + opacity: 0; + transition: opacity 0.15s; + text-decoration: none; + } + + .prose-spec .clause-link::before { + content: ""; + display: block; + width: 1rem; + height: 1rem; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%2394a3b8'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E"); + background-size: contain; + background-repeat: no-repeat; + } + + .dark .prose-spec .clause-link::before { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%23737373'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E"); + } + + /* Show anchor link on hover - only when not hovering nested lists */ + .prose-spec ol>li:hover:not(:has(ol:hover))>.clause-link, + .prose-spec ol>li:hover:not(:has(ol:hover))>p>.clause-link, + .prose-spec .clause-link:hover { + opacity: 1; + } + + .prose-spec .clause-link:hover::before { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke-width='2' stroke='%23f97316'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' d='M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244'/%3E%3C/svg%3E"); + } + .prose-spec img { max-width: 100%; height: auto; diff --git a/src/utils/parseSpecContent.ts b/src/utils/parseSpecContent.ts index 65c1804..1462cf7 100644 --- a/src/utils/parseSpecContent.ts +++ b/src/utils/parseSpecContent.ts @@ -6,7 +6,14 @@ import { unified } from "unified"; import remarkParse from "remark-parse"; import remarkRehype from "remark-rehype"; import rehypeStringify from "rehype-stringify"; -import type { Root, RootContent, Heading, List, ListItem } from "mdast"; +import type { + Root, + RootContent, + Heading, + List, + ListItem, + Html, +} from "mdast"; import type { Root as HastRoot } from "hast"; export interface TocItem { @@ -186,11 +193,12 @@ function findSpecSections(nodes: RootContent[]): SpecSection[] { const titles = extractListItemTitles(node as List); for (let i = 0; i < titles.length; i++) { const title = titles[i]; + const clauseNum = i + 1; sections.push({ - id: `spec-${slugify(title)}`, + id: `clause-${clauseNum}`, title, content: "", - clause: `${i + 1}.`, + clause: `${clauseNum}.`, }); } break; // Only process first ordered list @@ -201,33 +209,44 @@ function findSpecSections(nodes: RootContent[]): SpecSection[] { } /** - * Add anchor IDs to list items in the spec ordered list + * Add anchor IDs and links to ordered list items recursively. + * Injects an invisible anchor link before content for hover-to-reveal behavior. */ -function addAnchorsToList(list: List, sections: SpecSection[]): void { - const titleMap = new Map(sections.map((s) => [s.title, s.id])); - - for (const item of list.children) { +function addClauseAnchors(list: List, prefix: string = ""): void { + for (let i = 0; i < list.children.length; i++) { + const item = list.children[i]; if (item.type !== "listItem") continue; - // Get the title of this item - let title = ""; + // Calculate clause number and ID + const clauseNum = prefix ? `${prefix}.${i + 1}` : `${i + 1}`; + const clauseId = `clause-${clauseNum.replace(/\./g, "-")}`; + + // Add ID to the list item via hProperties + (item as ListItem & { data?: { hProperties?: { id?: string } } }).data = { + hProperties: { id: clauseId }, + }; + + // Find the first paragraph in the item and prepend an anchor link for (const child of item.children) { - if (child.type === "list") break; if (child.type === "paragraph") { - title = extractText(child).split("\n")[0].trim(); + // Create anchor link HTML to inject + const anchorHtml: Html = { + type: "html", + value: ``, + }; + // Prepend anchor to paragraph children + (child as { children: RootContent[] }).children.unshift( + anchorHtml as unknown as RootContent, + ); break; } - title += extractText(child); } - title = title.split("\n")[0].trim(); - // Add ID as data attribute (will be processed by rehype) - const id = titleMap.get(title); - if (id) { - // Add hProperties for rehype to convert to HTML id attribute - (item as ListItem & { data?: { hProperties?: { id?: string } } }).data = { - hProperties: { id }, - }; + // Recursively process nested ordered lists + for (const child of item.children) { + if (child.type === "list" && (child as List).ordered) { + addClauseAnchors(child as List, clauseNum); + } } } } @@ -339,10 +358,10 @@ export async function parseSpecContent( // Extract spec sections from the first ordered list const specSections = findSpecSections(specNodes); - // Add anchor IDs to spec list items + // Add anchor IDs and links to spec list items for (const node of specNodes) { if (node.type === "list" && (node as List).ordered) { - addAnchorsToList(node as List, specSections); + addClauseAnchors(node as List); break; } }