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

Add a doc page about user expectations #412

Open
yck011522 opened this issue Apr 12, 2024 · 2 comments
Open

Add a doc page about user expectations #412

yck011522 opened this issue Apr 12, 2024 · 2 comments
Assignees

Comments

@yck011522
Copy link
Contributor

yck011522 commented Apr 12, 2024

Add a page describing what users need to know in order to perform different tasks using compas_fab. This can go on the first introduction page or a deliciated page of its own.

Level 0 (Complete Layman / No Code)
Visualization

Level 1 (Typical users)
Define Robot Cell (Robot, Collision Environment, Tools, Workpieces)
Plan Motion
Plan Process

Level 2 (Advanced User)
Modify Robot Kinematics and Semantics (e.g. Planning Groups)
Custom Robot (e.g. multiple robots in cell)

Level 3 (Research level)
Extension with custom Motions and Planning Algorithms
Extension with custom Planning Backends
Configure planning parameters for individual planning backends

@yck011522 yck011522 self-assigned this Apr 12, 2024
@jf---
Copy link

jf--- commented Apr 16, 2024

+1

A nice way to approach this is perhaps through the use of the admonitions module?

@yck011522
Copy link
Contributor Author

@jf---
This is new to me. Does this require extra work to setup the doc building process?

Maybe I will draft the content first.

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

2 participants