search

conan-io / docs

conan.io reStructuredText documentation
http://docs.conan.io
MIT License
104 stars 356 forks source link

Docs improvements with common/best practices #3128

Open zillemarco opened 1 year ago

zillemarco commented 1 year ago

What is your suggestion?

After having some issues with copying dependencies DLLs to the build folder, I reached out in Slack and I got the help I needed (thanks a lot community! 💙)

The community rightfully pointed me to the documentation about how to migrate from Conan v1 to Conan v2, where there was an example of exactly what I was searching for.

The main issue though, is that someone has to at least know how something worked on Conan v1 in order to know that that thing is not working anymore and there is a new way of achieving the result.

As a Conan newbie, what I would love to see in the docs would be an area where some best/common practices are explained and easy to find 🙂

Have you read the CONTRIBUTING guide?

samuel-emrys commented 1 year ago

@zillemarco is this what you're looking for? https://docs.conan.io/2/knowledge/guidelines.html

zillemarco commented 1 year ago

Yes, exactly that! I totally missed that page 😓

I'll open a PR to add my use case as a Common practice (I guess) and see what the team thinks 🙂

Thanks a lot!

memsharded commented 1 year ago

Probably "Common practice" could be also FAQ. It sounds like the typical "how do I do this?", and that probably fits better the QA model than the guidelines model. We need to restructure and improve the FAQ by the way, don't take the current status like abs truth. But feel free to suggest the contents, and we will see where it fits best.

Moving this to the docs repo.