Autonomous-Motorsports-Purdue / AMP_ASSv3

Other
3 stars 3 forks source link

Add detailed documentation to existing packages #5

Closed alanssitis closed 1 year ago

alanssitis commented 1 year ago

Brief Description

Update documentation throughout the repo.

Details

Add documentation to every package.

Tasks

alanssitis commented 1 year ago

@Reschivon Do we need launch file descriptions in package READMEs?

Reschivon commented 1 year ago

I think a brief one line summary of what each file does would be nice. I think the rest of the readme would give the necessary context for what it does specifically. In some public ROS packages we often get a pile of launch files and it's ambiguous what they do.

alanssitis commented 1 year ago

I think a brief one line summary of what each file does would be nice. I think the rest of the readme would give the necessary context for what it does specifically. In some public ROS packages we often get a pile of launch files and it's ambiguous what they do.

Makes sense. Done!