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

Generate org-wide diagram of software components and their interconnections #34

Open
PeterBowman opened this issue Dec 16, 2018 · 1 comment

Comments

@PeterBowman
Copy link
Member

There is a pressing need to improve documentation for newcomers (but not only) in such a manner that the most important components would be accessible at first glance. In fact, people want to find and understand what is more relevant to their work without wasting time by first digging in our repos.

In a parallel train of thought, we would like to embrace a how-to approach (e.g. "how do I make TEO walk?") and develop a knowledge base of available and future information. These concerns first arised with regard to TEO and its dedicated developer-manual (so far the only one we have, at least with such detail), but we'd like to make it global. In short, a rather complex and lengthy diagram would result from this, somewhat resembling what is depicted in roboticslab-uc3m/kinematics-dynamics#123. Then, a posted could be generated and printed (see also #32).

@PeterBowman
Copy link
Member Author

BTW perhaps the yarpviz utility might be of use here to generate a diagram of port connections.

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