You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The gh-pages branch is outdated and is not maintained. We should aim for one single source of documentation and possibly generate multiple output from there.
The text was updated successfully, but these errors were encountered:
I removed the URL, now i returns 404 error. I disabled the building of the branch. I did not emptied however the branch.
What would be your suggestion for the documentation? Do you have a good example in mind?
We maintain READMEs, however right now the backend README is quite complex. We also have some wiki pages, but only because to not add those text to README. So if we decide a new tarteg for the documentation, these could be the sources.
An option would be to create a handbook for all of qa-catalogue, written with quarto, and reduce each README to one page, linking to the handbook. But this is work and time is limited!
quarto sounds good. What do you think about the practicalities: would it require to create a new repository (e.g. qa-catalogue-handbook), or should we use a branch of existing repo (e.g. qa-catalogue)?
It should better be a new repository because it should cover multiple source code repositories. The book can bue build and published via GitHub Action as we do here - I could create a boilerplate but only after vacation in three weeks.
The gh-pages branch is outdated and is not maintained. We should aim for one single source of documentation and possibly generate multiple output from there.
The text was updated successfully, but these errors were encountered: