AlexsLemonade / AlexsLemonade/OpenScPCA-analysis
Docs request: Reframe the "running an analysis module" doc
- Dominant language
- HTML
- Stars
- 16
- Forks
- 24
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 4
Description
### What is the documentation improvement or update you wish to see?
While looking over https://openscpca.readthedocs.io/en/latest/contributing-to-analyses/analysis-modules/running-a-module, I wondered if we achieved the right scope for this page. To me, the title "running an analysis module" implies does on how someone else could run a module. Yet, we mostly discuss writing a script that enables running the analysis module, which is more a concept related to authors establishing a module, vs contributors running a module. In addition, we don't include any discussion of setting up an environment to run a module besides simply stating "the readme should have all the info."
### Is there any additional context you would like to provide?
Just tagging in @dvenprasad for any thoughts on whether this page suits us and discuss what updates/reorgs we might benefit from.
### If this request is for an existing documentation page, please provide the link here.
https://openscpca.readthedocs.io/en/latest/contributing-to-analyses/analysis-modules/running-a-module/
Contributor guide
Research direction
Read the linked running-a-module page and compare its current focus on writing a script with the stated audience of contributors running a module. Clarify the intended scope with the maintainers, then reframe or reorganize the page to address running a module and environment setup, with the revised page making that scope clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100