# More options for documentation for activities and config please

**URL:** <https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095>\
**Category:** Feedback and suggestions\
**Created:** [March 23, 2026, 2:20pm UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095 "2026-03-23T14:20:17Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![noahsprent](https://forum.pioreactor.com/user_avatar/forum.pioreactor.com/noahsprent/32/383_2.png) [@noahsprent](https://forum.pioreactor.com/u/noahsprent)\
**Post date:** [March 23, 2026, 2:20pm UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095/1 "2026-03-23T14:20:18Z")

</div>

![image](https://forum.pioreactor.com/uploads/default/original/1X/b9dbe3787acf5ac2d83e358a622fe70dc895a119.png)  
Example from an inbuilt job - I’d love to be able to edit this page a bit to give more details. If someone installs a plugin designed to e.g. do PID pH control, it’s useful for the documentation to be right there

---

<div class="post-metadata">

**Author:** ![CamDavidsonPilon](https://forum.pioreactor.com/user_avatar/forum.pioreactor.com/camdavidsonpilon/32/3_2.png) [@CamDavidsonPilon](https://forum.pioreactor.com/u/CamDavidsonPilon)\
**Post date:** [March 23, 2026, 2:26pm UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095/2 "2026-03-23T14:26:58Z")

</div>

Yea I agree, this view is too terse, and there’s no way to learn more.

Are you thinking of

1. taking the “comments” from config.ini parameters and displaying them beside each field?
2. Link to external documentation
3. Some other “editable” metadata / yaml / file?

---

<div class="post-metadata">

**Author:** ![noahsprent](https://forum.pioreactor.com/user_avatar/forum.pioreactor.com/noahsprent/32/383_2.png) [@noahsprent](https://forum.pioreactor.com/u/noahsprent)\
**Post date:** [March 24, 2026, 6:08am UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095/3 "2026-03-24T06:08:49Z")

</div>

A YAML sets these in the first place, right? I think adding description there would probably be best. Comments in config can be easily deleted by the user. Then the author can decide if they want to add links to external documentation

---

<div class="post-metadata">

**Author:** ![CamDavidsonPilon](https://forum.pioreactor.com/user_avatar/forum.pioreactor.com/camdavidsonpilon/32/3_2.png) [@CamDavidsonPilon](https://forum.pioreactor.com/u/CamDavidsonPilon)\
**Post date:** [March 24, 2026, 3:43pm UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095/4 "2026-03-24T15:43:57Z")

</div>

these fields are pulled from the config.ini infact, from the `[<job_name>.config]` section.

> Comments in config can be easily deleted by the user.

Yes, they can be, hmm

---

<div class="post-metadata">

**Author:** ![noahsprent](https://forum.pioreactor.com/user_avatar/forum.pioreactor.com/noahsprent/32/383_2.png) [@noahsprent](https://forum.pioreactor.com/u/noahsprent)\
**Post date:** [March 25, 2026, 4:25pm UTC](https://forum.pioreactor.com/t/more-options-for-documentation-for-activities-and-config-please/1095/5 "2026-03-25T16:25:12Z")

</div>

Oh right, my bad yes. I guess it called also be pulled using some structure like a docstring/comments in the code for the job, which is less user-facing