From 82a32c0b247d6f2884ea1fc839286fc384778512 Mon Sep 17 00:00:00 2001
From: Pooya Parsa <pooya@pi0.io>
Date: Wed, 13 Mar 2024 20:55:03 +0100
Subject: [PATCH] chore: add banner about data accuracy (#64)

* chore: add banner about data accuracy

* Update README.md

Co-authored-by: Tom Lienard <tom.lienrd@gmail.com>

---------

Co-authored-by: Tom Lienard <tom.lienrd@gmail.com>
---
 README.md                |  5 ++++-
 apps/website/src/app.vue | 13 ++++++++-----
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 4f31fe1..d4866f6 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,10 @@
 
 <!-- /automd -->
 
-Display APIs compatibility across different JavaScript runtimes. The data is automatically generated, based on MDN [`browser-compat-data`](https://github.com/mdn/browser-compat-data) format using the runtime tests from [`mdn-bcd-collector`](https://github.com/openwebdocs/mdn-bcd-collector). Runtimes are displayed with their [WinterCG Runtime Key](https://runtime-keys.proposal.wintercg.org).
+Display APIs compatibility across different JavaScript runtimes. The data is automatically generated, based on MDN [`browser-compat-data`](https://github.com/mdn/browser-compat-data) format using the runtime tests from [`mdn-bcd-collector`](https://github.com/openwebdocs/mdn-bcd-collector).
+
+> [!WARNING]
+> The current data is not 100% accurate and is auto generated. Please [open an issue](https://github.com/unjs/runtime-compat/issues) if you have spotted any inconsistencies.
 
 ## About the data
 
diff --git a/apps/website/src/app.vue b/apps/website/src/app.vue
index 5e3b5fa..80225d8 100644
--- a/apps/website/src/app.vue
+++ b/apps/website/src/app.vue
@@ -10,15 +10,17 @@
           href="https://github.com/unjs/runtime-compat/tree/main/packages/runtime-compat-data">
           runtime-compat-data
         </ExternalLink>, based on MDN's format.
-        Runtimes are displayed with their <ExternalLink href="https://runtime-keys.proposal.wintercg.org">
-          WinterCG Runtime Key
-        </ExternalLink>.
+      </p>
+      <p class="bg-yellow-100 border-l-4 border-yellow-500 text-yellow-700 p-4" role="alert">
+        <strong>Note:</strong> The current data is not 100% accurate and is auto generated.
+        Please <ExternalLink href="https://github.com/unjs/runtime-compat/issues">open an issue</ExternalLink> if you
+        have spotted any inconsistencies.
       </p>
       <label class="flex items-center gap-2">
         <input type="checkbox" class="rounded" v-model="winterCGOnly" />
         <span class="text-md text-slate-600">Filter by WinterCG APIs ({{ computedData.winterCGCount }}/{{
-          computedData.totalCount
-        }})</span>
+        computedData.totalCount
+      }})</span>
       </label>
     </div>
     <div class="sticky top-0 z-10 pointer-events-none max-w-full">
@@ -50,6 +52,7 @@
 <script setup lang="ts">
 import runtimeCompatData, { type CompatStatement, type Identifier, type RuntimeName } from 'runtime-compat-data';
 import { changeScroll } from './lib'
+import ExternalLink from './components/ExternalLink.vue';
 
 const runtimes = Object.keys(runtimeCompatData.api.AbortController.__compat?.support ?? {}) as RuntimeName[]
 const selectedRuntimes = useState<string[]>('selectedRuntimes', () => runtimes)