docs: add JSDocs for Mission Status - Githubissues

akhenry / openmct-yamcs

Open MCT YAMCS plugin

13 stars 9 forks source link

docs: add JSDocs for Mission Status #432

Closed ozyx closed 5 months ago

ozyx commented 6 months ago

Closes #431

Describe your changes:

Document setup and configuration of YAMCS MDB / roles.yaml for Mission Status. Also adds JSDocs (with types) for Mission Status.

All Submissions:

[x] Have you followed the guidelines in our Contributing document?
[x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
[x] Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

[x] Changes address original issue?
[ ] Tests included and/or updated with changes?
[x] Command line build passes?
[x] Has this been smoke tested?
[ ] Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

[ ] Changes appear to address issue?
[ ] Reviewer has tested changes by following the provided instructions?
[ ] Changes appear not to be breaking changes?
[ ] Appropriate automated tests included?
[ ] Code style and in-line documentation are appropriate?
[ ] Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
[ ] Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

charlesh88 commented 4 months ago

Testathon 2024-04-25 verified fixed, content looks great.