Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: organize top-level page better #438

Closed
jack-oquin opened this issue Jun 12, 2013 · 1 comment
Closed

documentation: organize top-level page better #438

jack-oquin opened this issue Jun 12, 2013 · 1 comment
Assignees

Comments

@jack-oquin
Copy link
Member

In my opinion, the top-level catkin documentation page has too much verbiage before new users get to see how the information is organized.

Users coming to catkin for the first time generally want to quickly find out how to do some specific task.

  • Since they are probably forced to use catkin, they don't need to know its key benefits right away.
  • For most, catkin is already installed with the rest of ROS, so only a few need that information, though it should be readily accessible early the index.

Please assign this to me, if possible. I'll write a draft to submit for review.

@ghost ghost assigned jack-oquin Jun 12, 2013
@jack-oquin
Copy link
Member Author

The second-level sections needed some reorgainzation, too:

  • Moved from "User Guide" to "Advanced Users Guide":
    • "How to build the docs"
  • Moved from "Index" to "User Guide":
  • "Installation"
  • Moved from "Advanced Users Guide" to "User Guide":
  • "Variables"
  • "Glossary"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant