[GH-ISSUE #1483] Feature request: Documentation site for community scripts #2870

New issue

Open

opened 2026-03-14 05:46:27 +03:00 by kerem · 0 comments

kerem commented

2026-03-14 05:46:27 +03:00

Owner

Originally created by @NiceGuyIT on GitHub (Apr 14, 2023).
Original GitHub issue: https://github.com/amidaware/tacticalrmm/issues/1483

Is your feature request related to a problem? Please describe.
As the community scripts grows, the ability to find what you need shrinks. The existing interfaces to the script library provide at most a search which returns a list of scripts matching the search term. It does not provide the description, purpose of the script, or anything of meaningful value.

Describe the solution you'd like
It would be nice if the community scripts had a documentation site that explains the purpose of the script, how to use it, caveats to using the script, etc. Most languages provide a means to document the code such that Markdown or HTML can be generated. Automating the process to convert the script documentation tags to markdown for hosting on a static site with a search feature would be 🌠.

Describe alternatives you've considered
N/A

Additional context

Python uses docstrings.
- docstring-to-markdown can do "On the fly conversion of Python docstrings to markdown".
PowerShell uses comment based help.
- PlatyPS can "Generate markdown help (example) for your existing modules"
Side note: Don't confuse decorators with documenting code. While some decorators add can add types to variables, they modify the code they are decorating.

Originally created by @NiceGuyIT on GitHub (Apr 14, 2023). Original GitHub issue: https://github.com/amidaware/tacticalrmm/issues/1483 **Is your feature request related to a problem? Please describe.** As the [community scripts][] grows, the ability to find what you need shrinks. The existing interfaces to the script library provide at most a search which returns a list of scripts matching the search term. It does not provide the description, purpose of the script, or anything of meaningful value. **Describe the solution you'd like** It would be nice if the community scripts had a documentation site that explains the purpose of the script, how to use it, caveats to using the script, etc. Most languages provide a means to document the code such that Markdown or HTML can be generated. Automating the process to convert the script documentation tags to markdown for hosting on a static site with a search feature would be :stars:. **Describe alternatives you've considered** N/A **Additional context** - Python uses [docstrings][]. - [docstring-to-markdown][] can do "On the fly conversion of Python docstrings to markdown". - PowerShell uses [comment based help][]. - [PlatyPS][] can "Generate markdown help ([example](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelp.md)) for your existing modules" - Side note: Don't confuse [decorators][] with documenting code. While some decorators add can add types to variables, they modify the code they are decorating. [community scripts]: https://github.com/amidaware/community-scripts [decorators]: https://en.wikipedia.org/wiki/Decorator_pattern [docstrings]: https://peps.python.org/pep-0257/ [comment based help]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.3 [PlatyPS]: https://github.com/PowerShell/platyPS [docstring-to-markdown]: https://github.com/python-lsp/docstring-to-markdown