search

gazebosim / docs

High-level Gazebo documentation that gets published to https://gazebosim.org/docs/
https://gazebosim.org/docs
52 stars 122 forks source link

Consolidate Library READMEs with installation tutorials #14

Open chapulina opened 4 years ago

chapulina commented 4 years ago

Some libraries have repeated content in their installation tutorials and READMEs Choose one or the other for each library to have

ahcorde commented 4 years ago

Consolidated install documentation for the following libraries (Moved install instructions to the tutorials folder):

chapulina commented 4 years ago

Thanks for taking this on, @ahcorde !

I commented on one of the PRs, but for completeness I'll mention it here too that we should be linking to the published link of those installation tutorials, such as

https://ignitionrobotics.org/api/math/6.4/install.html

The reasons are:

chapulina commented 3 years ago

Reopening as we're still missing some libraries:

mabelzhang commented 3 years ago

The tutorials may not always render correctly on GitHub, their canonical location is on the ignitionrobotics.org site

I'm consolidating ign-common at the moment.

Do we want to keep the relative section links, e.g. the links to different types of installs under the Overview section here:

They don't jump correctly in the canonical location https://ignitionrobotics.org/api/math/6.8/install.html#binary-install

But they jump correctly on GitHub https://github.com/ignitionrobotics/ign-math/blob/ign-math6/tutorials/installation.md

chapulina commented 3 years ago

Do we want to keep the relative section links

Yeah I recently noticed that too. I think we should remove them since they don't work on the main site.