From b314daaeb01f668a16aa21cd6f2ff7654677da16 Mon Sep 17 00:00:00 2001 From: zhouzhou626 <255877794+zhouzhou626@users.noreply.github.com> Date: Wed, 20 May 2026 05:04:50 +0800 Subject: [PATCH] docs: clarify dev container scope Signed-off-by: zhouzhou626 <255877794+zhouzhou626@users.noreply.github.com> --- documentation/general/general_setup.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/documentation/general/general_setup.md b/documentation/general/general_setup.md index 6aad49576d7..484fa2badcf 100644 --- a/documentation/general/general_setup.md +++ b/documentation/general/general_setup.md @@ -5,6 +5,14 @@ is the only supported method of working with Openverse. `ov` is included in the repository, and its only dependencies are git, bash, and Docker (or a compatible container runtime). +```{note} +If VS Code detects `.devcontainer/devcontainer.json` and offers to reopen the +repository in a dev container, do not use that prompt for local setup. The +dev container configuration is only intended and tested for GitHub Codespaces, +and only for frontend and documentation contributions. For local development, +follow this guide and use `ov` directly from your clone. +``` + ```{admonition} Openverse and Windows :class: caution Openverse development is currently supported only for UNIX-type environments