Psych-DS Docs Roundup Issue

[bleonar5]

Psych-DS Documentation Plan

Objectives

This document outlines the outstanding steps to get the Psych-DS documentation up to speed.

Action Items

1. Update Core Documentation

   • Finalize and publish updates to the Psych-DS README regarding API changes and npm installs #5
   • Add a developer page to the Psych-DS readthedocs
   • Review and Push new docs website #10
   • Update schema ref generation script for new docs
   • Add section on creating richer variableMeasured objects #11
   • Guiding Principles and Raw/Primary #12

2. Incorporate Feedback

   • Review and integrate remaining content changes from the feedback document

3. Enhance User Feedback Mechanism

   • Develop and implement a feedback widget for the web validator
   • Ensure feedback is automatically converted into GitHub issues with appropriate tags

4. Create Educational Resources

   • Tutorial metadata options #6
   • Develop concise, context-specific text tutorials

5. Expand Resource Library

   • Create an "Additional Resources" page on the website
   • Create CSV and JSON explanation pages #9
   • Establish a dedicated repository folder for platform/context-specific templates
     • Example: Jupyter Notebook template