summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/contributing-data.md17
-rw-r--r--docs/docs/telemetry.md4
-rw-r--r--docs/docusaurus.config.js12
-rw-r--r--docs/sidebars.js2
-rw-r--r--docs/static/img/contribute-data-off.pngbin0 -> 30599 bytes
-rw-r--r--docs/static/img/contribute-data-on.pngbin0 -> 32008 bytes
6 files changed, 33 insertions, 2 deletions
diff --git a/docs/docs/contributing-data.md b/docs/docs/contributing-data.md
new file mode 100644
index 00000000..0e257668
--- /dev/null
+++ b/docs/docs/contributing-data.md
@@ -0,0 +1,17 @@
+# Contributing data
+
+You might have noticed the toggle at the bottom of the Continue GUI. Right now, all it does is send anonymous telemetry about whether it is on or off. **No data is being collected.** We are using it to gather feedback as to whether or not developers would be willing to contribute data about their software development workflows to an open-source dataset.
+
+If there are enough developers who signal interest, we will then move forward with collecting data from those who opt-in and make the dataset publicly accessible. Our hope is that this dataset could then be used by anyone to train a new class of [foundation models](https://fsi.stanford.edu/publication/opportunities-and-risks-foundation-models) for software development that can help us not only “tab autocomplete” but also “task autocomplete” as we create software.
+
+There will be many discussions and iterations with the community before we consider collecting the dataset in order to ensure that the approach works for them, and in no situation will any action taken prior to this point cause users to have their data collected without clear, additional consent. If you have thoughts or questions about this, please reach out to us at contribute@continue.dev. We want to hear from you!
+
+In summary, this is what you should do:
+
+- Toggle data contribution `on` when you would be willing to share your software development data to a public dataset **in the future**
+
+![contribute-data-on](/img/contribute-data-on.png)
+
+- Toggle data contribution `off` when you would not be willing to share your software development data to a public dataset **in the future**
+
+![icontribute-data-off](/img/contribute-data-off.png) \ No newline at end of file
diff --git a/docs/docs/telemetry.md b/docs/docs/telemetry.md
index d0b04180..4464ae53 100644
--- a/docs/docs/telemetry.md
+++ b/docs/docs/telemetry.md
@@ -8,7 +8,9 @@ We use [Posthog](https://posthog.com/), an open source platform for product anal
## What we track
-We track the steps that are run and their parameters.
+We track
+- the steps that are run and their parameters
+- if the data contribution toggle is switched on / off
## How to opt out
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 7746a87b..c29fa140 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -115,6 +115,18 @@ const config = {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
+ algolia: {
+ // The application ID provided by Algolia
+ appId: '0OMUMCQZVV',
+
+ // Public API key: it is safe to commit it
+ apiKey: '6795de0f612eebe17018f8061a9ef18e',
+
+ indexName: 'continue',
+
+ // Optional: see doc section below
+ contextualSearch: true,
+ },
}),
};
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 82ef7056..f4c1ecbd 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -13,7 +13,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
- docsSidebar: ["intro", "getting-started", "how-continue-works", "telemetry"],
+ docsSidebar: ["intro", "getting-started", "how-continue-works", "telemetry", "contributing-data"],
};
module.exports = sidebars;
diff --git a/docs/static/img/contribute-data-off.png b/docs/static/img/contribute-data-off.png
new file mode 100644
index 00000000..3a37906c
--- /dev/null
+++ b/docs/static/img/contribute-data-off.png
Binary files differ
diff --git a/docs/static/img/contribute-data-on.png b/docs/static/img/contribute-data-on.png
new file mode 100644
index 00000000..633a547c
--- /dev/null
+++ b/docs/static/img/contribute-data-on.png
Binary files differ