Documentatie site

Onderdeel van het startproject is een automatisch gegenereerde documentatie site met behulp van TypeDoc.

Deze site wordt gegenereerd op basis van de Markdown-bestanden in de docs-map en de geschreven TSDoc in de code van zowel de Frontend- als Backend applicatie.

Bij het pushen naar de main-brach, zal de site automatisch gegenereerd en uitgerold worden naar de Gitlab Pages van het Gitlab Project. Hiermee heb jij, maar ook de Product Owner direct toegang tot alle (technische) documentatie van het project. Ook vind je hier de documentatie van de LucaStars Game Engine™, gezien je startproject daar de volledige broncode van bevat.

Privacygevoelige informatie

Gitlab Pages is een openbare website, gegeven dat je de juiste URL kunt gokken. Zet dus geen privacygevoelige informatie in jullie documentatie zoals telefoonnummers en e-mailadressen.

Zoals al eerder beschreven heb je een documentatieplicht voor het Scrum-proces, alsmede voor vele andere verwachte producten. Ditzelfde geldt ook voor het toepassen van TSDoc op je eigen code, zoals ook is vermeld in de Definition of Done.

In de docs-map van je startproject vind je een index.md met uitleg hoe je structuur kunt aanbrengen in je documenten. Lees deze even door!

Gitlab Pages

De URL van je documentatie site vind je op je Gitlab projectpagina onder Deploy > Pages.