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

Update documentation #106

Open
ipa-rmb opened this issue Jun 16, 2016 · 1 comment
Open

Update documentation #106

ipa-rmb opened this issue Jun 16, 2016 · 1 comment

Comments

@ipa-rmb
Copy link
Contributor

ipa-rmb commented Jun 16, 2016

In order to have a general overview of the squirrel software and be more efficient during the integration meetings, our software should be properly documented. On one hand, with installation and execution instructions and, on the other hand, with a software architecture diagram to see the interconnections and dependencies between the modules. It is not necessary a diagram per node, only the most important nodes that subscribe or publish topics used by other components.

The squirrel_recommender package holds the templates and a small tutorial about how to create the diagram https://github.com/squirrel-project/squirrel_recommender#Documentation-and-Templates (2.Documentation and Templates). Please use these templates to create your documentation.

@bajo
Copy link
Contributor

bajo commented Jul 26, 2016

@ipa-nhg @ipa-rmb I think all the packages in squirrel_perception have this now. Can we close this issue?

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

No branches or pull requests

2 participants