Projektin kuvaus
MikÀ ongelma ratkaistaan?
Useiden ohjelmistoprojektien dokumentaatio on usein hajallaan eri repositorioissa ja vaikeasti löydettÀvissÀ. Dokumentaation pÀivittÀminen ja julkaisu vaatii manuaalista työtÀ, ja navigaatio eri projektien vÀlillÀ voi olla sekavaa. LisÀksi visuaaliset elementit, kuten kaaviot, eivÀt aina ole helposti tuettavissa. Monet olemassa olevat ratkaisut ovat raskaita yllÀpitÀÀ.
Miten projekti ratkaisee ongelman?
TÀmÀ projekti tarjoaa keskitetyn dokumentaatiosivuston, joka:
- Kokoaa eri projektien dokumentaatiot yhteen paikkaan (esim. panualaluusua.fi/docs), jolloin kaikki tieto löytyy helposti yhdestÀ osoitteesta.
- Automaattinen julkaisu ja pÀivitys: Jokaisen projektin CI/CD-pipeline rakentaa ja kopioi dokumentaation tÀhÀn keskitettyyn repositorioon, josta se julkaistaan automaattisesti GitHub Pagesiin.
- Automaattinen navigaatio: Sivuston navigaatio rakentuu kansiorakenteen perusteella, joten uusia dokumentaatioita ei tarvitse lisÀtÀ kÀsin valikkoon.
- Visuaalinen tuki: Materiaaliteeman ja Mermaid-kaavioiden ansiosta dokumentaatio on visuaalisesti selkeÀÀ ja helposti laajennettavaa.
- Kevyt yllÀpito: Ratkaisu on yksinkertaisempi ja kevyempi yllÀpitÀÀ kuin esimerkiksi Docusaurus-pohjaiset ratkaisut.
Yhteenveto
Projekti ratkaisee dokumentaation hajanaisuuden ja pÀivityksen manuaalisuuden yhdistÀmÀllÀ dokumentaatiot automaattisesti yhteen, helposti yllÀpidettÀvÀÀn sivustoon, jossa navigointi ja visuaalisuus ovat keskeisiÀ ominaisuuksia.