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

Community feedback: Documentation #25

Open
mzettwitz opened this issue May 3, 2019 · 0 comments
Open

Community feedback: Documentation #25

mzettwitz opened this issue May 3, 2019 · 0 comments
Assignees

Comments

@mzettwitz
Copy link
Collaborator

mzettwitz commented May 3, 2019

Call for your help!

We want to improve our documentation. Since we as the developers have all the background knowledge about the system and especially the source code, it's hard to find lacks in the documentation.
We call for your help to fix this for you. If you find unclear or weak formulations in the documentation, especially in the API reference, you are welcome to blame us :) So please show us the parts that confuse you.
Before you post a problem, please make sure you have read the documentation for this behaviour entirely. Meaning: both the front- and back-end API, the component reference and the same for the base class.

Post it here using the following pattern:

<Component name>, < link to doc >, "unclear formulation"
'Your problem of understanding in a brief explanation'

Example:

Orbit, Orbit.DeltaAngle, "Specifies the target position on the orbit."
How is the target position specified by the DeltaAngle? What does the angle influence and how?

@mzettwitz mzettwitz self-assigned this May 3, 2019
@mzettwitz mzettwitz pinned this issue May 3, 2019
@martinkirst martinkirst unpinned this issue Jun 1, 2019
@martinkirst martinkirst changed the title Community feedback: documentation Community feedback: Documentation Aug 16, 2019
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

1 participant