lookit / lookit-docs

Documentation for Lookit project, including use of platform and lookit-api, ember-lookit-frameplayer, and exp-addons repos.
MIT License
2 stars 359 forks source link

Add new EFP updates page with info about RecordRTC/Pipe #382

Closed becky-gilbert closed 7 months ago

becky-gilbert commented 7 months ago

Fixes #323

You can see a mostly formatted version of the new page here: https://github.com/lookit/lookit-docs/blob/add-efp-updates-recordrtc/docs/source/researchers-runner-releases.rst

There are some values in the new doc page that I will need to add in after the EFP RecordRTC version is actually released. These are written with placeholders like [DATE], [COMMIT SHA] etc.

becky-gilbert commented 7 months ago

@ianchandlercampbell when we're going through your local docs set up, I can show you how to pull this branch down and build the docs locally so that you can see what my changes will actually look like on the docs site. (The Github-formatted version here is better than viewing it in plain text, but is missing the formatting for things like section headers, internal links, and call-out boxes).

becky-gilbert commented 7 months ago

@ianchandlercampbell after merging your edits, I did the following:

I think this is now ready to go! If you want to review the final version, you can see the Github-formatted version here. Or in your local docs repository, you can update your local branch with my changes:

git pull origin add-efp-updates-recordrtc

and then build the docs from inside the docs subfolder:

cd docs
.\make html

Assuming you don't want any further changes, then tomorrow I will:

ianchandlercampbell commented 7 months ago

@becky-gilbert That sounds like a great plan! I've added one extra commit to fix a copyediting error that I'm pretty sure I introduced with my last round of edits, but otherwise everything looks good on my end. Excited to get this out!