Create list of implemented components (experimentalists, theorists, etc)

[benwandrew]

here: https://github.com/AutoResearch/autora/blob/main/docs/experimentalist/index.md

• [x] Experimentalists
• [x] Theorists
• [x] Experiment Runners

[gtdang]

Add to contributor guide the requirement to add to the list of experimentalists. Also applies to the theorist.

[benwandrew]

going off @gtdang's comment above, it seems like we should do either of the following:

(i) have a list like this for the top-level index.md for every component (experimentalists, theorists, and runners, broken down by experimentation and recruitment managers

(ii) accept that all the subpages of each component section, which already summarize and describe the core functions, arguments, etc in much more detail, sufficiently depict what's currently implemented. having a "list of implemented [x]" seems a bit redundant; users can readily see what's implemented directly under the drop-downs for each section. the top-level lists aren't unhelpful, but not sure they merit another thing to stay on top of given that the information is already apparent...

@younesStrittmatter @musslick @chadcwilliams thoughts?

[musslick]

going off @gtdang's comment above, it seems like we should do either of the following:

(i) have a list like this for the top-level index.md for every component (experimentalists, theorists, and runners, broken down by experimentation and recruitment managers

(ii) accept that all the subpages of each component section, which already summarize and describe the core functions, arguments, etc in much more detail, sufficiently depict what's currently implemented. having a "list of implemented [x]" seems a bit redundant; users can readily see what's implemented directly under the drop-downs for each section. the top-level lists aren't unhelpful, but not sure they merit another thing to stay on top of given that the information is already apparent...

@younesStrittmatter @musslick @chadcwilliams thoughts?

I'm advocating for (i) for the following reason:

• Having a top-level overview allows the users to gain an overview of all packages without a single click. Yes, the list of vetted packages is also available in the drop-down menu. However, getting an overview of every package requires clicking through the various navigation bars, which is far more effortful than looking at a summary.
• With this overview, we can immediately link not only to the documentation but also to the pip/conda packages with installation instructions
• maintaining such a curated list is useful for other reasons (e.g., grant proposals) that require us to summarize the state of the open-source ecosystem.

[younesStrittmatter]

I thought we were talking about the list here: https://autoresearch.github.io/autora/experimentalist/ (at the end of the page). There, the experimentalists and the math equations for them are listed.
I don't think an additional list with only the names of the experimentalists/theoristst makes sense since we already see them in the nav menu. On the other hand, a list with the equations (or a very short overview of the theorists) would make sense to give the users a brief overview. I am not sure where to put that list, though (on the landing page of AutoRa or on the index pages of the components)

[musslick]

Yes, a list with names wouldn't make sense, I agree. The overview list should therefore not just include the name but also:

• package name
• link to package
• link to doc page
• brief description of what it does (e.g., in the form of an equation)

I suggest placing the list on each component site (Theorist, Experimentalist, etc.).