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

docs: reorganized behavioral experiment runner doc #675

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

musslick
Copy link
Collaborator

Description

The documentation for running behavioral experiments was scattered across sections, and it was also not clear how the different components and subpackages relate to one another. Furthermore, the doc structure was obscure as to whether AutoRA can support other types of automated data collection.

The following restructuring is an attempt to fix these issues:

- Behavioral Web Experiments:
    - Home: 'experiment-runner/behavioral/index.md'
    - Example: 'experiment-runner/behavioral/example.md'
    - Using Firebase: 'experiment-runner/behavioral/firebase.md'
    - Firebase-Prolific Runner: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
    - Firebase Experimentation Manager: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]'
    - Prolific Recruitment Manager: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'

Type of change

  • docs: Documentation only changes

Remarks (Optional)

  • the PR is not intended to complete the runner doc but merely to restructure it. That said, the behavioral experiment runner doc could likely be improved further.

@musslick musslick added documentation Improvements or additions to documentation. enhancement New feature or request. labels Oct 21, 2024
@musslick musslick self-assigned this Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. enhancement New feature or request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant