search

space-ros / docs

The Space ROS documentation site.
Creative Commons Attribution 4.0 International
8 stars 11 forks source link

Add a documentation outline #6

Closed mjeronimo closed 1 year ago

mjeronimo commented 1 year ago

Add a structure for the Space ROS documentation site that has empty placeholder pages and TODO lists. Also update the logo and color scheme to better match the Space ROS website.

nuclearsandwich commented 1 year ago

What do you think about consolidating some of the "Use $TOOL" articles into a single using static analysis tools page with sections? A lot of them are going to have the same start and end and only the middle will be different and we can avoid repeating a lot of content that way.

I'm also going back and forth in my mind about whether a lot of these how to guides need an explicit. "... with Space ROS" at the end of the title or if the Space ROS docs site has that implicitly. But part of me is irked by the idea of generic "how to use cobra" guides appearing on the docs site rather than being focused on the Space ROS integration. In particular I don't want to create a "Use Earthly" guide since they have tutorials for doing so I'd rather integrate that into a "First time building Space ROS" tutorial and "Reproducing CI results locally" guide respectively.

mjeronimo commented 1 year ago

@nuclearsandwich I don't think we have enough pages yet on static analyzers to consolidate. Open to doing that or creating a sub-tree for static analysis when we have more.

I think we can be careful with the "... with Space ROS" items. Only use it if helps to avoid ambiguity, for example.

I've added the suggested CI-related pages and dropped the "Using Earthly" page.