Koodikanta Shadow-dokumentaationa
Mitä Code Base Shadow Docsina tarkoittaa
Kun synkronoit GitHub-repositorion Archbeen Spaceen, voit tuoda Code basesi kyseiseen Spaceen Shadow Docsina. Käy katsomassa Varjodokumentit saadaksesi lisätietoja.
Tämä tarkoittaa, että meidän AI-järjestelmä indeksoi kaiken synkronoitavaksi määrittämäsi koodin ja kouluttaa Kysy AI-avustajalta annetulla code basella.
Yksikään Shadow Docs -kansioon lisätty dokumentti ei näy julkaistussa portaalissasi asiakkaillesi eikä sisäisille käyttäjillesi. Shadow Docsin kautta toimitettu koodi on olemassa vain AI:n kouluttamista varten, jotta se pystyy vastaamaan käyttäjiesi koodia koskeviin kysymyksiin.
Miten voin käyttää sitä?
Tässä on kaksi yleisintä käyttötapausta:
- Synkronoi sovelluksesi code base Archbeen Spaceen. Julkaise sisäinen (suojattu, ei julkinen) portaali teknisille ja ei-teknisille tiimeillesi. Tämä AI:n tukema portaali pystyy nyt vastaamaan kysymyksiin ja jopa ehdottamaan, kuinka erilaisia parannuksia, integraatioita, optimointeja jne. voidaan toteuttaa code basesi perusteella.
- Synkronoi sovelluksesi code base Archbeen Spaceen. Julkaise julkinen portaali käyttäjillesi. Tässä käyttäjäsi voivat saada suoria vastauksia siihen, kuinka sovellustasi, API:a, SDK:ta, kirjastoja jne. käytetään
Miten konfiguroidaan
Ensin sinun täytyy konfiguroida GitHub-integraatio kuten tässä selitetään.
Sen jälkeen sinun täytyy määrittää repositorio
Sinun täytyy konfiguroida shadowDocs-parametri archbee.yaml-tiedostossa sen code basen polulla, jonka haluat synkronoida Archbeen kanssa.
# Tämä sisällyttää kaikki kooditiedostot repostasi
shadowDocs:
- "*"# Tämä sisällyttää vain index.ts-kooditiedoston
shadowDocs:
- "init/index.ts"
# Sisällyttääksesi myös dokumentaatiotiedostoja docs-kansiosta
root: docsTältä se näyttää tuonnin jälkeen
Varmista, että AI-lisäosa on käytössä Organisation Settingsissa
Yhteenveto
- Yhtäkään Shadow Docsin kautta synkronoitua kooditiedostoa ei julkaista missään vaiheessa julkisesti
- Koko tarkoitus on tarjota konteksti AI:llemme, jotta se voi vastata teknisiin kysymyksiin ja tehdä teknisiä ehdotuksia sisäisille tai julkisille käyttäjillesi