SRGSSR / pillarbox-documentation

Technical cross-platform documentation for Pillarbox
https://www.pillarbox.ch/
MIT License
3 stars 0 forks source link

Add docsify and json schemas for monitoring specs #96

Closed jboix closed 2 months ago

jboix commented 3 months ago

Description

The goal of these changes is to automate the generation of a static webpage for the documentation and to formally define the event format for the monitoring specification using JSON schemas.

Changes made

github-actions[bot] commented 3 months ago

PR Preview Action v1.4.8 :---: Preview removed because the pull request was closed. 2024-09-24 08:13 UTC

amtins commented 3 months ago

@jboix quick question, what is the added value of generating a static website, isn't the git repo enough?

jboix commented 3 months ago

@amtins Good question! I think the static website brings some added value. For one, it makes navigation easier, so you can quickly find what you're looking for without digging through folders. Plus, the homepage gives us a chance to present the project in a way that's a bit more polished and marketable. Something like this:

image

I asked the team before starting but if you have any thoughts or concerns we can discuss about it.