Code base as Shadow docs

4 min

what is code base as shadow docs when you sync a github repo to a space in archbee, you have the possibility of importing your code base into that space as shadow docs visit / / /spaces/ai addon md to learn more this means that our / / /spaces/ai addon md will index all the code you configured to be synched and will train the / / /spaces/ai addon md with the provided code base every document added to the shadow docs folder will not be visible on your published portal, neither for your customers or for your internal users the code provided via shadow docs will just be there to train your ai and be able to answer questions about your code for your users how can i use it? here are 2 of the most common use cases sync your app code base to an archbee space publish an internal(protected, not public) portal for your tech& non tech teams this portal, powered by our ai, will now be able to answer questions and even suggest how to perform different improvements, integrations, optimizations, etc based on your code base sync your app code base to an archbee space publish a public portal for your users here your users will be able to get direct answers on how to use your app, apis, sdk, libraries, etc how to configure first you need to configure the github integration / /github md then you need to docid\ gzw8tycbknc7nrt6bbdls in the archbee yaml file you need to configure the shadowdocs parameter with the path of your code base that you want to sync with archbee archbee yaml # this will include all code files from your repo shadowdocs \ " " archbee yaml # this will include only the index ts code file shadowdocs \ "init/index ts" \# to also include documentation files from docs folder root docs this is how it will look after import make sure you have your ai addon enabled in organisation settings sum up all code files sync through shadow docs will not be made public at any time the whole purpose is to provide context to our ai so it can answer technical questions and make technical suggestions to your internal or public users