Openstatus www.openstatus.dev

๐Ÿš‘ docs link (#1367)

* ๐Ÿš‘

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

authored by

Thibault Le Ouay
autofix-ci[bot]
and committed by
GitHub
45571966 960ece0b

+69 -28
+4
apps/docs/astro.config.mjs
··· 3 3 import tailwindcss from "@tailwindcss/vite"; 4 4 import { defineConfig, envField } from "astro/config"; 5 5 import starlightImageZoom from "starlight-image-zoom"; 6 + import starlightLinksValidator from "starlight-links-validator"; 6 7 import starlightLlmsTxt from "starlight-llms-txt"; 7 8 8 9 import Icons from "unplugin-icons/vite"; ··· 179 180 "OpenStatus is an open-source global uptime monitoring platform that offers a status page and monitoring as code.", 180 181 }), 181 182 starlightImageZoom(), 183 + starlightLinksValidator({ 184 + errorOnLocalLinks: false, 185 + }), 182 186 ], 183 187 }), 184 188 ],
+1
apps/docs/package.json
··· 20 20 "astro": "5.13.7", 21 21 "sharp": "0.33.5", 22 22 "starlight-image-zoom": "0.13.0", 23 + "starlight-links-validator": "0.17.2", 23 24 "starlight-llms-txt": "0.5.1", 24 25 "starlight-showcases": "0.3.0", 25 26 "starlight-sidebar-topics": "0.6.0",
+4 -4
apps/docs/src/content/docs/concept/getting-started.mdx
··· 5 5 6 6 Hereโ€™s some content to help you get started with the concept behind OpenStatus. 7 7 8 - - [Uptime Monitoring](/tutorial/uptime-monitoring) 8 + - [Uptime Monitoring](/concept/uptime-monitoring) 9 9 10 - - [Best Practices for Status Pages](/tutorial/best-practices-status-page) 10 + - [Best Practices for Status Pages](/concept/best-practices-status-page) 11 11 12 - - [Uptime Monitoring as Code](/tutorial/uptime-monitoring-as-code) 12 + - [Uptime Monitoring as Code](/concept/uptime-monitoring-as-code) 13 13 14 - - [Latency vs Response Time](/tutorial/latency-vs-response-time) 14 + - [Latency vs Response Time](/concept/latency-vs-response-time)
+1 -1
apps/docs/src/content/docs/concept/uptime-monitoring-as-code.mdx
··· 80 80 81 81 ### Making Changes with the CLI 82 82 83 - Once your `openstatus.yaml` file is ready, you use our [command-line interface (CLI)](tutorial/get-started-with-openstatus-cli) to apply the changes. The CLI compares your local configuration with the current state of your monitors and applies only the necessary changesโ€”creating new monitors, updating existing ones, or deleting those no longer defined. 83 + Once your `openstatus.yaml` file is ready, you use our [command-line interface (CLI)](/tutorial/get-started-with-openstatus-cli) to apply the changes. The CLI compares your local configuration with the current state of your monitors and applies only the necessary changesโ€”creating new monitors, updating existing ones, or deleting those no longer defined. 84 84 85 85 **Common CLI Commands:** 86 86
+1 -1
apps/docs/src/content/docs/guides/how-to-monitor-mcp-server.mdx
··· 35 35 36 36 ### YAML Configuration 37 37 38 - The [OpenStatus CLI](/cli/getting-started/) allows you to create monitor defined in a YAML configuration file. This is perfect solution if want to manage your monitors via GitOps. 38 + The [OpenStatus CLI](/tutorial/get-started-with-openstatus-cli) allows you to create monitor defined in a YAML configuration file. This is perfect solution if want to manage your monitors via GitOps. 39 39 40 40 Here's an example of a monitor configuration for Hugging Face MCP server: 41 41
+1 -1
apps/docs/src/content/docs/monitoring/monitoring-as-code.mdx
··· 14 14 15 15 ## Getting Started 16 16 17 - OpenStatus provides a [CLI](/cli/getting-started) tool that allows you to create, update, and delete monitors as code. To get started, you need to install the CLI tool. 17 + OpenStatus provides a [CLI](/tutorial/get-started-with-openstatus-cli) tool that allows you to create, update, and delete monitors as code. To get started, you need to install the CLI tool. 18 18 19 19 ## Examples 20 20
+57 -21
pnpm-lock.yaml
··· 342 342 starlight-image-zoom: 343 343 specifier: 0.13.0 344 344 version: 0.13.0(@astrojs/starlight@0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1))) 345 + starlight-links-validator: 346 + specifier: 0.17.2 347 + version: 0.17.2(@astrojs/starlight@0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1))) 345 348 starlight-llms-txt: 346 349 specifier: 0.5.1 347 350 version: 0.5.1(@astrojs/starlight@0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)))(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)) ··· 1112 1115 version: link:../../packages/tsconfig 1113 1116 '@types/bun': 1114 1117 specifier: latest 1115 - version: 1.2.21(@types/react@19.1.10) 1118 + version: 1.2.22(@types/react@19.1.10) 1116 1119 typescript: 1117 1120 specifier: 5.7.2 1118 1121 version: 5.7.2 ··· 1241 1244 version: 0.7.1(typescript@5.7.2)(zod@3.24.2) 1242 1245 drizzle-orm: 1243 1246 specifier: 0.44.4 1244 - version: 0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.21(@types/react@19.1.10)) 1247 + version: 0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.22(@types/react@19.1.10)) 1245 1248 drizzle-zod: 1246 1249 specifier: 0.5.1 1247 - version: 0.5.1(drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.21(@types/react@19.1.10)))(zod@3.24.2) 1250 + version: 0.5.1(drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.22(@types/react@19.1.10)))(zod@3.24.2) 1248 1251 zod: 1249 1252 specifier: 3.24.2 1250 1253 version: 3.24.2 ··· 6220 6223 '@types/braces@3.0.5': 6221 6224 resolution: {integrity: sha512-SQFof9H+LXeWNz8wDe7oN5zu7ket0qwMu5vZubW4GCJ8Kkeh6nBWUz87+KTz/G3Kqsrp0j/W253XJb3KMEeg3w==} 6222 6225 6223 - '@types/bun@1.2.21': 6224 - resolution: {integrity: sha512-NiDnvEqmbfQ6dmZ3EeUO577s4P5bf4HCTXtI6trMc6f6RzirY5IrF3aIookuSpyslFzrnvv2lmEWv5HyC1X79A==} 6226 + '@types/bun@1.2.22': 6227 + resolution: {integrity: sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA==} 6225 6228 6226 6229 '@types/caseless@0.12.4': 6227 6230 resolution: {integrity: sha512-2in/lrHRNmDvHPgyormtEralhPcN3An1gLjJzj2Bw145VBxkQ75JEXW6CTdMAwShiHQcYsl2d10IjQSdJSJz4g==} ··· 6366 6369 6367 6370 '@types/pg@8.6.1': 6368 6371 resolution: {integrity: sha512-1Kc4oAGzAl7uqUStZCDvaLFqZrW9qWSjXOmBfdgyBP5La7Us6Mg4GBvRlSoaZMhQF/zSj1C8CtKMBkoiT8eL8w==} 6372 + 6373 + '@types/picomatch@3.0.2': 6374 + resolution: {integrity: sha512-n0i8TD3UDB7paoMMxA3Y65vUncFJXjcUf7lQY7YyKGl6031FNjfsLs6pdLFCy2GNFxItPJG8GvvpbZc2skH7WA==} 6369 6375 6370 6376 '@types/prop-types@15.7.12': 6371 6377 resolution: {integrity: sha512-5zvhXYtRNRluoE/jAp4GVsSduVUzNWKkOZrCDBWYtE7biZywwdC2AcEzg+cSMLFRfVgeAFqpfNabiPjxFddV1Q==} ··· 6874 6880 bun-types@1.0.8: 6875 6881 resolution: {integrity: sha512-2dNB+dBwAcFW7RSd4y5vKycRjouKVklSwPk4EjBKWvcMYUBOqZGGNzV7+b2tfKBG3BeRXnozbnegVKR1azuATg==} 6876 6882 6877 - bun-types@1.2.21: 6878 - resolution: {integrity: sha512-sa2Tj77Ijc/NTLS0/Odjq/qngmEPZfbfnOERi0KRUYhT9R8M4VBioWVmMWE5GrYbKMc+5lVybXygLdibHaqVqw==} 6883 + bun-types@1.2.22: 6884 + resolution: {integrity: sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA==} 6879 6885 peerDependencies: 6880 6886 '@types/react': ^19 6881 6887 ··· 8385 8391 iron-webcrypto@1.2.1: 8386 8392 resolution: {integrity: sha512-feOM6FaSr6rEABp/eDfVseKyTMDt+KGpeB35SkVn9Tyn0CqvVsY3EwI0v5i8nMHyJnzCIQf7nsy3p41TPkJZhg==} 8387 8393 8394 + is-absolute-url@4.0.1: 8395 + resolution: {integrity: sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A==} 8396 + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} 8397 + 8388 8398 is-alphabetical@2.0.1: 8389 8399 resolution: {integrity: sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==} 8390 8400 ··· 10696 10706 starlight-image-zoom@0.13.0: 10697 10707 resolution: {integrity: sha512-7K/7gshnKooYd4ePy5vtyv1jFoFVNUb8IoXWDcnY69+nxvmLATNrmOzD2M4TJ/aKynPSBSM6j9ia4s/PPy/JGA==} 10698 10708 engines: {node: '>=18'} 10709 + peerDependencies: 10710 + '@astrojs/starlight': '>=0.32.0' 10711 + 10712 + starlight-links-validator@0.17.2: 10713 + resolution: {integrity: sha512-d2SRWu04HPiUzrzntuv/uzuXnIu4reJwzX1c+7uvcnqOCuzgpv+tmlUC+dp3VYpmfxQy8RX+xcWtfcEkx905VA==} 10714 + engines: {node: '>=18.17.1'} 10699 10715 peerDependencies: 10700 10716 '@astrojs/starlight': '>=0.32.0' 10701 10717 ··· 15874 15890 '@rollup/pluginutils': 5.1.4(rollup@3.29.5) 15875 15891 commondir: 1.0.1 15876 15892 estree-walker: 2.0.2 15877 - fdir: 6.4.6(picomatch@4.0.2) 15893 + fdir: 6.4.6(picomatch@4.0.3) 15878 15894 is-reference: 1.2.1 15879 15895 magic-string: 0.30.17 15880 - picomatch: 4.0.2 15896 + picomatch: 4.0.3 15881 15897 optionalDependencies: 15882 15898 rollup: 3.29.5 15883 15899 ··· 15885 15901 dependencies: 15886 15902 '@types/estree': 1.0.8 15887 15903 estree-walker: 2.0.2 15888 - picomatch: 4.0.2 15904 + picomatch: 4.0.3 15889 15905 optionalDependencies: 15890 15906 rollup: 3.29.5 15891 15907 ··· 16974 16990 16975 16991 '@types/braces@3.0.5': {} 16976 16992 16977 - '@types/bun@1.2.21(@types/react@19.1.10)': 16993 + '@types/bun@1.2.22(@types/react@19.1.10)': 16978 16994 dependencies: 16979 - bun-types: 1.2.21(@types/react@19.1.10) 16995 + bun-types: 1.2.22(@types/react@19.1.10) 16980 16996 transitivePeerDependencies: 16981 16997 - '@types/react' 16982 16998 ··· 17135 17151 '@types/node': 24.0.8 17136 17152 pg-protocol: 1.10.3 17137 17153 pg-types: 2.2.0 17154 + 17155 + '@types/picomatch@3.0.2': {} 17138 17156 17139 17157 '@types/prop-types@15.7.12': {} 17140 17158 ··· 17840 17858 17841 17859 bun-types@1.0.8: {} 17842 17860 17843 - bun-types@1.2.21(@types/react@19.1.10): 17861 + bun-types@1.2.22(@types/react@19.1.10): 17844 17862 dependencies: 17845 17863 '@types/node': 24.0.8 17846 17864 '@types/react': 19.1.10 ··· 18398 18416 transitivePeerDependencies: 18399 18417 - supports-color 18400 18418 18401 - drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.21(@types/react@19.1.10)): 18419 + drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.22(@types/react@19.1.10)): 18402 18420 optionalDependencies: 18403 18421 '@cloudflare/workers-types': 4.20250303.0 18404 18422 '@libsql/client': 0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5) ··· 18406 18424 '@opentelemetry/api': 1.9.0 18407 18425 '@types/pg': 8.11.10 18408 18426 better-sqlite3: 11.7.0 18409 - bun-types: 1.2.21(@types/react@19.1.10) 18427 + bun-types: 1.2.22(@types/react@19.1.10) 18410 18428 18411 - drizzle-zod@0.5.1(drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.21(@types/react@19.1.10)))(zod@3.24.2): 18429 + drizzle-zod@0.5.1(drizzle-orm@0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.22(@types/react@19.1.10)))(zod@3.24.2): 18412 18430 dependencies: 18413 - drizzle-orm: 0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.21(@types/react@19.1.10)) 18431 + drizzle-orm: 0.44.4(@cloudflare/workers-types@4.20250303.0)(@libsql/client-wasm@0.14.0)(@libsql/client@0.15.14(bufferutil@4.0.8)(utf-8-validate@6.0.5))(@opentelemetry/api@1.9.0)(@types/pg@8.11.10)(better-sqlite3@11.7.0)(bun-types@1.2.22(@types/react@19.1.10)) 18414 18432 zod: 3.24.2 18415 18433 18416 18434 dset@3.1.4: {} ··· 18834 18852 dependencies: 18835 18853 format: 0.2.2 18836 18854 18837 - fdir@6.4.2(picomatch@4.0.2): 18855 + fdir@6.4.2(picomatch@4.0.3): 18838 18856 optionalDependencies: 18839 - picomatch: 4.0.2 18857 + picomatch: 4.0.3 18840 18858 18841 18859 fdir@6.4.6(picomatch@4.0.2): 18842 18860 optionalDependencies: ··· 19610 19628 ipaddr.js@1.9.1: {} 19611 19629 19612 19630 iron-webcrypto@1.2.1: {} 19631 + 19632 + is-absolute-url@4.0.1: {} 19613 19633 19614 19634 is-alphabetical@2.0.1: {} 19615 19635 ··· 22629 22649 transitivePeerDependencies: 22630 22650 - supports-color 22631 22651 22652 + starlight-links-validator@0.17.2(@astrojs/starlight@0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1))): 22653 + dependencies: 22654 + '@astrojs/starlight': 0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)) 22655 + '@types/picomatch': 3.0.2 22656 + github-slugger: 2.0.0 22657 + hast-util-from-html: 2.0.3 22658 + hast-util-has-property: 3.0.0 22659 + is-absolute-url: 4.0.1 22660 + kleur: 4.1.5 22661 + mdast-util-mdx-jsx: 3.2.0 22662 + mdast-util-to-string: 4.0.0 22663 + picomatch: 4.0.3 22664 + unist-util-visit: 5.0.0 22665 + transitivePeerDependencies: 22666 + - supports-color 22667 + 22632 22668 starlight-llms-txt@0.5.1(@astrojs/starlight@0.35.2(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)))(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)): 22633 22669 dependencies: 22634 22670 '@astrojs/mdx': 4.3.0(astro@5.13.7(@types/node@24.0.8)(encoding@0.1.13)(jiti@2.4.2)(lightningcss@1.30.1)(rollup@4.45.1)(terser@5.43.1)(typescript@5.7.2)(yaml@2.6.1)) ··· 22913 22949 22914 22950 tinyglobby@0.2.10: 22915 22951 dependencies: 22916 - fdir: 6.4.2(picomatch@4.0.2) 22917 - picomatch: 4.0.2 22952 + fdir: 6.4.2(picomatch@4.0.3) 22953 + picomatch: 4.0.3 22918 22954 22919 22955 tinyglobby@0.2.14: 22920 22956 dependencies: