From 82ec9909280517a207073e5a6d681e357a1c5172 Mon Sep 17 00:00:00 2001 From: Matt Hillsdon Date: Wed, 27 Mar 2024 09:12:51 +0000 Subject: [PATCH 1/3] Document using alternative Sanity project/dataset --- docs/tech-overview.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/tech-overview.md b/docs/tech-overview.md index d253c2bbe..6b21b2f45 100644 --- a/docs/tech-overview.md +++ b/docs/tech-overview.md @@ -32,7 +32,11 @@ To produce the correct data format to flash a micro:bit, we use the Foundation's ## The sidebar and educational content -The Reference and Ideas sidebar tabs show educational content that is managed in the Micro:bit Educational Foundation's content management system (CMS). The content is currently sourced live from the CMS. For non-localhost deploys this will require CORS configuration on our end. Please open an issue to discuss this. +The Reference and Ideas sidebar tabs show educational content that is managed in the Micro:bit Educational Foundation's content management system (Sanity CMS). This content is not Open Source. The content is sourced live from the CMS APIs. It will work for local development but non-Foundation deployments will see CORS errors. + +You can substitute your own content by setting `VITE_SANITY_PROJECT` and `VITE_SANITY_DATASET` environment variables, overriding the defaults in `.env`. The schemas we use for Sanity CMS are [packaged as a plugin in this GitHub project](https://github.com/microbit-foundation/sanity-plugin-python-editor-v3/). + +We also plan to explore adding Markdown documentation support as an alternative to Sanity CMS. You can follow the discussion [on this GitHub issue](PENDING). The API tab shows detailed documentation of the MicroPython API for users who need more detail than the curated content in the Reference tab provides. The API tab content is generated at runtime from the bundled type stubs for MicroPython. We do this using an enhancement to the Foundation's fork of Pyright. For more details see [Python code intelligence](#python-code-intelligence). From cbe04a52660cd4c0f0f9668cb07a6beac10ba49d Mon Sep 17 00:00:00 2001 From: Matt Hillsdon <44397098+microbit-matt-hillsdon@users.noreply.github.com> Date: Wed, 27 Mar 2024 09:21:27 +0000 Subject: [PATCH 2/3] Add issue link --- docs/tech-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tech-overview.md b/docs/tech-overview.md index 6b21b2f45..1f026523f 100644 --- a/docs/tech-overview.md +++ b/docs/tech-overview.md @@ -36,7 +36,7 @@ The Reference and Ideas sidebar tabs show educational content that is managed in You can substitute your own content by setting `VITE_SANITY_PROJECT` and `VITE_SANITY_DATASET` environment variables, overriding the defaults in `.env`. The schemas we use for Sanity CMS are [packaged as a plugin in this GitHub project](https://github.com/microbit-foundation/sanity-plugin-python-editor-v3/). -We also plan to explore adding Markdown documentation support as an alternative to Sanity CMS. You can follow the discussion [on this GitHub issue](PENDING). +We also plan to explore adding Markdown documentation support as an alternative to Sanity CMS. You can follow the discussion on #1160. The API tab shows detailed documentation of the MicroPython API for users who need more detail than the curated content in the Reference tab provides. The API tab content is generated at runtime from the bundled type stubs for MicroPython. We do this using an enhancement to the Foundation's fork of Pyright. For more details see [Python code intelligence](#python-code-intelligence). From 14f197c6bac9a08600a36ef21eb6190fed0c1e87 Mon Sep 17 00:00:00 2001 From: Matt Hillsdon <44397098+microbit-matt-hillsdon@users.noreply.github.com> Date: Wed, 27 Mar 2024 09:22:40 +0000 Subject: [PATCH 3/3] Fix issue link --- docs/tech-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tech-overview.md b/docs/tech-overview.md index 1f026523f..3c58e556c 100644 --- a/docs/tech-overview.md +++ b/docs/tech-overview.md @@ -36,7 +36,7 @@ The Reference and Ideas sidebar tabs show educational content that is managed in You can substitute your own content by setting `VITE_SANITY_PROJECT` and `VITE_SANITY_DATASET` environment variables, overriding the defaults in `.env`. The schemas we use for Sanity CMS are [packaged as a plugin in this GitHub project](https://github.com/microbit-foundation/sanity-plugin-python-editor-v3/). -We also plan to explore adding Markdown documentation support as an alternative to Sanity CMS. You can follow the discussion on #1160. +We also plan to explore adding Markdown documentation support as an alternative to Sanity CMS. You can follow the discussion on [#1160](https://github.com/microbit-foundation/python-editor-v3/issues/1160). The API tab shows detailed documentation of the MicroPython API for users who need more detail than the curated content in the Reference tab provides. The API tab content is generated at runtime from the bundled type stubs for MicroPython. We do this using an enhancement to the Foundation's fork of Pyright. For more details see [Python code intelligence](#python-code-intelligence).