Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split form study details #443

Merged
merged 18 commits into from
Dec 13, 2024
Merged

Split form study details #443

merged 18 commits into from
Dec 13, 2024

Conversation

okaycj
Copy link
Contributor

@okaycj okaycj commented Nov 26, 2024

Summary

Fixes #327

This PR covers a few issues:

  • Adds a sphinx development server to the make file and requirements.
  • Update language around the "Create Study" button.
  • Update screenshots of study details page.
  • Update screenshots/language on updating EFP's commit SHA
  • A few other small fixes here and there

Copy link
Contributor

@becky-gilbert becky-gilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

Copy link
Contributor

@becky-gilbert becky-gilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This screenshot has localhost as the domain for the preview and study links, which maybe isn't ideal but not a big deal either.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many users won't be familiar with GH, so it might be useful to show more of this page, e.g. full width and just from top down to the commit info. Then again, maybe it doesn't matter because I'm not sure how useful this section is anyway. I think it's much easier for users to just click the "Check for updates" button on the site, read commit descriptions and grab the commit SHAs there.

.. _`Setting study fields`: researchers-set-study-fields.html

.. _`study list page`: https://childrenhelpingscience.com/exp/studies/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do know if these links names/references are case-sensitive? In "study list page", the "s" is lower case here and upper case where it's referenced in the text above. I had a quick look in the sphinx rst docs here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks but couldn't find a quick answer.

@becky-gilbert becky-gilbert merged commit d08bdbd into develop Dec 13, 2024
@becky-gilbert becky-gilbert deleted the split-form-study-details branch December 13, 2024 21:30
@becky-gilbert
Copy link
Contributor

@okaycj do you know if you updated the python version in your docs virtual environment? I tried updating my environment with the updated requirements doc in this PR, and I get some errors about ignoring certain packages/versions that are not compatible with python 3.8.

Screenshot 2024-12-13 at 2 49 20 PM

I tried just running make livehtml anyway but that didn't work. It did work after I installed sphinx autobuild directly: pip install sphinx-autobuild.

Is this just me doing something wrong? Or if we are updating python, then we should change the readme installation instructions, which say to use 3.8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UPDATE, STRUCTURE - Update study details pages for new split form
3 participants