Closed bgunnar5 closed 7 months ago
oh. my. goodness. this is beautiful.
Looks like they build ok! https://merlin--460.org.readthedocs.build/en/460/
@lucpeterson @koning do you know if we have a merlin banner with white text instead of black? Are there already svg versions somewhere?
@doutriaux1 The "+" icon for the code block annotations comes as part of an extension for mkdocs so changing it would be non-trivial. Do you mind if I leave it as is for now? I can look into this more in the future if we still think it should be changed
@bgunnar5 don't worry about the + icon if it's a pain. For the Merlin png/svg/white, you can probably just use gimp to create these. Or one of the millions png to svg websites :)
I sent you a link to the original file with the logo. You can use it to mod as you wish!
Thx Luc!
From: Luc Peterson @.> Date: Wednesday, January 24, 2024 at 10:25 AM To: LLNL/merlin @.> Cc: Doutriaux, Charles @.>, Mention @.> Subject: Re: [LLNL/merlin] docs/conversion-to-mkdocs (PR #460)
I sent you a link to the original file with the logo. You can use it to mod as you wish!
— Reply to this email directly, view it on GitHubhttps://urldefense.us/v3/__https:/github.com/LLNL/merlin/pull/460*issuecomment-1908691716__;Iw!!G2kpM7uM-TzIFchu!3XIZTik_Zc4zFXrDud2_-WXz4kCaviLQfzQrGYOHN2NnXzNrO18PvrRS3Zq7ubJcAUDmUa-hprrvHO5Mz_zl0A4Xf2RQ$, or unsubscribehttps://urldefense.us/v3/__https:/github.com/notifications/unsubscribe-auth/AAVHB4L7RCL4NNJJRJPKWM3YQFG2DAVCNFSM6AAAAABCFXUM3CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBYGY4TCNZRGY__;!!G2kpM7uM-TzIFchu!3XIZTik_Zc4zFXrDud2_-WXz4kCaviLQfzQrGYOHN2NnXzNrO18PvrRS3Zq7ubJcAUDmUa-hprrvHO5Mz_zl0IvHJo7U$. You are receiving this because you were mentioned.Message ID: @.***>
I would change your tcsh mentions to just csh, since it is the base shell.
I've taken the existing docs and ported them from sphinx to mkdocs to give a new style to Merlin's documentation and some extra explanations. This involved slightly re-organizing the docs a bit.
I've added:
Getting Started
sectionUser Guide
Running Studies
: explains the different ways to run studies, restart them, etc.Interpreting Output
: helps users understand the output workspaceExamples
page that will detail the examples provided withmerlin example list
hello
example is done, the rest I'll do laterContact
pageI've also modified the
Configuration
page to:External Server
andMerlin Server
for both external and containerized setup instructionsI modified the
Installation
page to contain the instructions for a pip/venv setup as well as a spack setup.I set up a place for API docs to go but will need to go through the entire codebase to get that setup, so that will be later on a separate branch.