Kodebasis as Shadow docs
Wat is Code Base as Shadow Docs
Wanneer u 'n GitHub repo na 'n Space in Archbee sinkroniseer, het u die moontlikheid om u Code base as Shadow Docs in daardie Space in te voer. Besoek Skadu-dokumente om meer te leer.
Dit beteken dat ons AI-stelsel al die Code wat u gekonfigureer het om gesinkroniseer te word, sal indekseer en die Vra AI-assistent met die verskafde code base sal oplei.
Elke dokument wat by die Shadow Docs-lêergids gevoeg word, sal nie sigbaar wees nie op u gepubliseerde portaal, nóg vir u kliënte nóg vir u interne gebruikers. Die code wat via Shadow Docs verskaf word, sal net daar wees om u AI op te lei en vrae oor u code vir u gebruikers te kan beantwoord.
Hoe kan ek dit gebruik?
Hier is 2 van die mees algemene gebruiksgevalle:
- Sinkroniseer u app code base na 'n Archbee Space. Publiseer 'n interne (beskermde, nie publieke) portaal vir u tegniese en nie-tegniese spanne. Hierdie portaal, aangedryf deur ons AI, sal nou vrae kan beantwoord en selfs kan voorstel hoe om verskillende verbeterings, integrasies, optimaliserings, ens. uit te voer gebaseer op u code base.
- Sinkroniseer u app code base na 'n Archbee Space. Publiseer 'n publieke portaal vir u gebruikers. Hier sal u gebruikers direkte antwoorde kan kry oor hoe om u App, APIs, SDK, Libraries, ens. te gebruik
Hoe om te konfigureer
Eerstens moet u die GitHub-integrasie konfigureer soos hier verduidelik.
Dan moet u stel die repository op
In die archbee.yaml-lêer moet u die skaduDokumente parameter konfigureer met die pad van u code base wat u met Archbee wil sinkroniseer.
# Dit sal alle code-lêers vanaf u repo insluit
shadowDocs:
- "*"# Dit sal slegs die index.ts code-lêer insluit
shadowDocs:
- "init/index.ts"
# Om ook dokumentasie-lêers vanaf die docs-lêergids in te sluit
root: docsDit is hoe dit sal lyk ná invoer

Maak seker dat u KI-byvoeging in Organisation Settings geaktiveer het
Opsomming
- Alle code-lêers wat deur Shadow Docs gesinkroniseer word, sal op geen tydstip publiek gemaak word nie
- Die hele doel is om konteks aan ons AI te verskaf sodat dit tegniese vrae kan beantwoord en tegniese voorstelle aan u interne of publieke gebruikers kan maak