Documentation

[Nenuial]

This is my attempt at reorganising the documentation.

I tried reorganising everything that was present in the README into different vignettes. I hope it makes sense, otherwise don't hesitate to say so!

This PR should close #46, close #57, close #66 and close #67.

[Nenuial]

@maelle Any ideas how to fix the Windows R-CMD-check? It looks to me as if the babelquarto package isn't available when he tries to build the vignettes 🤯.

[maelle]

Thanks so much!!

[maelle]

I feel the README should feature a few more lines, maybe saying using babelquarto means registering languages once per project/language and then using babelquarto dedicated function to render the book locally or on CI?

[maelle]

and maybe also links to examples. Basically more of a showcase.

[Nenuial]

I've made the Getting started part a bit more detailed.

For the links, do you have any ideas? The ropensci devguide obviously. But any other projects you are aware of that we could mention?

[maelle]

do we really want to maintain this workflow example? Could we instead explain what file to take as starting point then what steps to add? With a link to an example on GitHub from a "real" multilingual project.

[Nenuial]

That's an excellent question. I started with #57 and it did absolutely not work for me.

I feel that it would be nice to have a complete example of how to deploy a multilingual babelquarto project on GH Pages. But I can understand your argument that this configuration can easily not work for somebody project depending on what they do in their book or website...

I'll give it some more thoughts.

[Nenuial]

I got the CI fixed in 6fe3ee3 by installing the package locally first.
But this is probably a bit unorthodox, and I can revert these changes if this is a bad idea. I wanted to check if it works.