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

Doc: extension of contribution documentation #445

Merged
merged 58 commits into from Jun 16, 2023
Merged

Doc: extension of contribution documentation #445

merged 58 commits into from Jun 16, 2023

Conversation

musslick
Copy link
Collaborator

Description

I revised/added some of the main contribution doc, such as for core contributions, module contributions, theorist contributions, and experimentalist contributions.

Type of change

Delete as appropriate:

  • docs: Documentation only changes

Features (Optional)

  • bulleted list of features, describing the code contributions in this pull request

Questions (Optional)

  • @younesStrittmatter Would it be possible to add an experiment_runner-module.md describing the different types of contributions (following the structure in theorist-module.md and experimentalist-module.md)? This would also be the place where we should list synthetic data/experiment runners.

@musslick musslick added the documentation Improvements or additions to documentation. label Jun 15, 2023
@musslick musslick self-assigned this Jun 15, 2023
Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

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

this is really good stuff, @musslick!

docs/contribute/core.md Outdated Show resolved Hide resolved
docs/contribute/core.md Outdated Show resolved Hide resolved
docs/contribute/core.md Outdated Show resolved Hide resolved
docs/contribute/experimentalist-module.md Outdated Show resolved Hide resolved
docs/contribute/experimentalist-module.md Outdated Show resolved Hide resolved
docs/contribute/module.md Outdated Show resolved Hide resolved
docs/contribute/module.md Outdated Show resolved Hide resolved
docs/contribute/module.md Outdated Show resolved Hide resolved
docs/contribute/module.md Outdated Show resolved Hide resolved
docs/contribute/module.md Outdated Show resolved Hide resolved
@benwandrew
Copy link
Collaborator

btw, i love the new color-coded images specific to theorist, experimentalist, and experiment runner!

musslick and others added 9 commits June 16, 2023 08:06
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
musslick and others added 19 commits June 16, 2023 11:04
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

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

Don't forget to add experimentalist-module.md to the mkdocs.yml file

Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

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

contributor docs coming along nicely!


```

### Implementing samplers
Copy link
Collaborator

Choose a reason for hiding this comment

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

sounds good to me. addressed in this file for this PR, and will address globally in a separate PR

@benwandrew benwandrew self-requested a review June 16, 2023 15:55
Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

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

good to go as far as i'm concerned!


```

### Implementing samplers
Copy link
Collaborator

Choose a reason for hiding this comment

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

actually, decided to just implement in this PR...

@musslick musslick added this pull request to the merge queue Jun 16, 2023
Merged via the queue into main with commit 1fe43d0 Jun 16, 2023
14 checks passed
@musslick musslick deleted the doc/exp-module branch June 16, 2023 16:10
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants