search

envire / envire-envire_core

Core part for the Environment Representation library
BSD 2-Clause "Simplified" License
7 stars 13 forks source link

Sectioin for Question and Answers in the Wiki? #26

Closed Rauldg closed 5 years ago

Rauldg commented 6 years ago

Shall we put in the wiki a section for Questions and Answers?

An example of a question would be:

How do I check if a frame exists in the graph?

Answer:

Use containsFrame

Rauldg commented 6 years ago

We could use stack exchange robotics for this

arneboe commented 6 years ago

The tutorials section on envire.github.io already naswres similar questions.

In my opinion we shouldn't split the documentation.

On 09/21/2017 02:18 PM, Raúl Domínguez wrote:

We could use stack exchange robotics https://robotics.stackexchange.com/ for this

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/envire/envire-envire_core/issues/26#issuecomment-331139352, or mute the thread https://github.com/notifications/unsubscribe-auth/AATJSAYJxR4g4UH__eldbSDbdkEFi7kIks5sklQmgaJpZM4PfCVm.

Rauldg commented 6 years ago

Actually if the answer is in the tutorials then the answer should be just a link to the correspondent tutorial. I this kind of tool would be very helpful for someone using the tool. Maybe the Wiki is not the nicest place. We have the askbot typically for questions and asnwers but as Envire is open, I think the platform for this should also be open.

arneboe commented 6 years ago

Maybe the best idea would be to just put the whole documentation and tutorials into the readme.md and remove it from the envire website.

I dont really see a reason to have the website as additional resource if all the info that is displayed on the website can just as well be written in the readme. The readme is markdown formatted, thus all the usual stuff like images, links, table of contents, etc. works just fine.

In reality nobody is going to update the website ever again. If we put the content in the readme at least it is easy to find and might get updated.

what do you think?

On 09/26/2017 11:06 AM, Raúl Domínguez wrote:

Actually if the answer is in the tutorials then the answer should be just a link to the correspondent tutorial. I this kind of tool would be very helpful for someone using the tool. Maybe the Wiki is not the nicest place. We have the askbot typically for this but as Envire is open, I think the platform for this questions and asnwers should also be open.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/envire/envire-envire_core/issues/26#issuecomment-332135357, or mute the thread https://github.com/notifications/unsubscribe-auth/AATJSCZrsyeU1TFixbonTOQx_8i_UVp5ks5smL59gaJpZM4PfCVm.

chhtz commented 6 years ago

I agree on reducing the number of resources which we want to maintain. For the API documentation it would actually be nice to get some auto-generated doxygen documentation (the current documentation at http://envire.github.io/packages/ is (mostly?) a mixture of blind-text, 404 and empty tables)

Rauldg commented 6 years ago

About the website, if nobody is responsible of its maintenance, then IMO it should disappear indeed.

Doxygen documentation is also good but still not as effective I think as the questions and answers approach for short to-the-point questions.

Questions and Answers is not the same as documentation. People may ask things with different wording and concepts can also be explained there. Furthermore rights to push on the repository are not required as they are for changing or improving the documentation.

For the case of the questions and answers, it is self maintained by the users like in stack exchange so it should not suppose much work for us.