---
title: 作为 Shadow 文档的代码库
slug: docs/cn/shadow
description: 了解如何将来自 GitHub 仓库的代码无缝集成到 Archbee 中，同时在已发布空间中不暴露代码文件。探索如何在 .archbee.yaml 文件中利用 "shadowDocs" 字段，通过指定来选择性地摄取代码文件
createdAt: 2023-10-25T08:02:57.516Z
---

### 什么是 Code Base 作为 Shadow Docs

当您将 GitHub repo 同步到 Archbee 中的某个 Space 时，您可以选择将您的 Code base 作为 Shadow Docs 导入该 Space。访问 [影子文档](docId\:ymc0e2aSlpyYDXpxAqVJ-) 以了解更多信息。

这意味着我们的 [AI 系统](docId\:ymc0e2aSlpyYDXpxAqVJ-) 将会索引您配置同步的所有 Code，并使用提供的 code base 来训练 [询问AI助手](docId\:ymc0e2aSlpyYDXpxAqVJ-)。

:::hint{type="info"}
添加到 Shadow Docs 文件夹中的每个文档**都不会显示** 在您发布的 portal 上，无论是客户还是内部用户都无法查看。通过 Shadow Docs 提供的 code 仅用于训练您的 AI，使其能够回答用户关于您代码的问题。
:::



### 我该如何使用它？

以下是两个最常见的使用场景：

1. 将您的 app code base 同步到某个 Archbee Space。发布一个内部（受保护、非公开）的 portal 给您的技术和非技术团队。该 portal 由我们的 AI 驱动，能够回答问题，甚至基于您的 code-base 提出改进、集成、优化等建议。
2. 将您的 app code base 同步到某个 Archbee Space。为您的用户发布一个公共 portal。在这里，您的用户能够直接获得关于如何使用您的 App、APIs、SDK、Libraries 等内容的答案。

### 如何配置

:::::WorkflowBlock
:::WorkflowBlockItem
首先，您需要配置 GitHub 集成，如此处所述：[如这里所解释。](docId\:jKxSM2OUEQN7lmZFOCVqo)

然后，您需要设置存储库 [设置存储库](docId\:damdINgvaFlGMmgBUiYXG)
:::

::::WorkflowBlockItem
在 archbee.yaml 文件中，您需要配置 `shadowDocs` 参数，将其设置为您想与 Archbee 同步的 code base 路径。

:::CodeblockTabs
archbee.yaml

```yaml
# This will include all code files from your repo
shadowDocs: 
  - "*"
```
:::

:::CodeblockTabs
archbee.yaml

```yaml
# This will include only the index.ts code file
shadowDocs: 
  - "init/index.ts"

# To also include documentation files from docs folder
root: docs
```
:::
::::

:::WorkflowBlockItem
导入后将显示如下

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/mckPJUmI_MTCWHf0G-bmo_github-shadow-light.png)
:::

:::WorkflowBlockItem
确保您在 Organisation Settings 中启用了 **AI 插件**
:::
:::::

:::hint{type="success"}
**总结**

- 通过 Shadow Docs 同步的所有 code 文件在任何时候都不会公开
- 其主要目的是为我们的 AI 提供上下文，使其能够回答技术问题，并向您的内部或公共用户提供技术建议
:::