Documentation for Elements

[researcherben]

1 - Detailed description of problem or enhancement

I'm attempting to help a coworker troubleshoot an issue with how to use merlin.hr_router. I'm looking for documentation on what could be connected to the component.

In the approach described on https://documentation.divio.com/, I'm seeking (first) an explanation and (second) a reference.

2 - Describe how to reproduce

I looked in repo directories like https://github.com/sstsimulator/sst-elements/tree/master/src/sst/elements/merlin/hr_router for a README but didn't see one.

I looked in the source code (https://github.com/sstsimulator/sst-elements/blob/master/src/sst/elements/merlin/hr_router/hr_router.h and https://github.com/sstsimulator/sst-elements/blob/master/src/sst/elements/merlin/hr_router/hr_router.cc and see the SST_ELI_DOCUMENT_ and inline comments.

There is a related ticket, https://github.com/sstsimulator/sst-elements/issues/1799, in which the immediate questions were answered, but no documentation for the elements was created outside of the response to the github issue.

I looked in https://github.com/sstsimulator/sst-documentation and https://github.com/sstsimulator/sst-tutorials but didn't see documentation for merlin.hr_router.

On the page http://sst-simulator.org/ I used the search functionality to find "merlin" but no results were relevant.

On the page http://sst-simulator.org/ I clicked "Documentation Hub" and was taken to http://sst-simulator.org/sst-docs/ (yay! Thank you.) Clicking through "SST Elements" took me to a page titled "QuickStart Motif Guide" and I wasn't able to find anything related to Merlin.

3 - What Operating system(s) and versions

None

4 - What version of external libraries (Boost, MPI)

Not applicable

5 - Provide sha1 of all relevant sst repositories (sst-core, sst-elements, etc)

HEAD of Master for sst-elements as of 2023-03-04: https://github.com/sstsimulator/sst-elements/commit/099169be7348ac5afe4a365f1121323f4593c6df

6 - Fill out Labels, Milestones, and Assignee fields as best possible

I don't have permissions to set the assignee or labels for this ticket.

[researcherben]

As an example of one approach to documentation, I've submitted https://github.com/sstsimulator/sst-elements/pull/2061 which is based on comments in #1799

[researcherben]

A coworker pointed me to http://sst-simulator.org/SSTPages/SSTDeveloperElementSummaryInfo/ so I've added links to that in the README; see https://github.com/sstsimulator/sst-elements/pull/2128 and https://github.com/sstsimulator/sst-elements/pull/2127

Some pages have content

• http://sst-simulator.org/SSTPages/SSTElementAriel/
• http://sst-simulator.org/SSTPages/SSTElementBalar/
• http://sst-simulator.org/SSTPages/SSTElementCassini/
• http://sst-simulator.org/SSTPages/SSTElementEmber/
• http://sst-simulator.org/SSTPages/SSTElementFirefly/
• http://sst-simulator.org/SSTPages/SSTElementMemHierarchy/

while others are stub pages

• http://sst-simulator.org/SSTPages/SSTElementCacheTracer/
• http://sst-simulator.org/SSTPages/SSTElementCramsim/
• http://sst-simulator.org/SSTPages/SSTElementGNA/
• http://sst-simulator.org/SSTPages/SSTElementKingsley/

while other elements don't get a hyperlink

• osseous
• mercury

The reason I hadn't discovered the above pages is because they are located under "Getting SST" and are not referenced on the "Documentation Hub" page http://sst-simulator.org/sst-docs/

[berquist]

Related: https://github.com/sstsimulator/sst-docs/issues/2