criteo / command-launcher

A command launcher 🚀 made with ❤️
https://criteo.github.io/command-launcher
MIT License
35 stars 7 forks source link

Is there an appetite for a docs review? #141

Open jdevera opened 1 week ago

jdevera commented 1 week ago

In my use of the command launcher, I create packages which I then host and I use the automatic update functionalities. To get there, I've been an avid consumer of the documentation. And it has been enough, since I did get it working, but I felt at times that I had to fight it a bit.

I thought I could perhaps contribute back by doing a light review of the docs, perhaps adding some things that I had to figure out from experimentation or the code. But before that I wanted to ask if there would be an appetite to receive such changes. I'm not asking for a commitment to accept them 😅 , but just about whether you think now this has the potential for being integrated.

bhou commented 2 days ago

Thanks for bringing this up. You are more than welcome to contribute to the documentation. I think there are three types of audiences for the documentation:

At Criteo, we have our own implementation of the administration infrastructure; I feel that part is not very user-friendly for the public audience. Today's documentation structure might not be very obvious for the other two scenarios either.

Feel free to push PRs on the doc.