Improve user and developer documentation, add DARWIN support, and configure MkDocs/readthedocs site#824
Open
lepotatoguy wants to merge 14 commits into
Open
Improve user and developer documentation, add DARWIN support, and configure MkDocs/readthedocs site#824lepotatoguy wants to merge 14 commits into
lepotatoguy wants to merge 14 commits into
Conversation
…-properties usage
Introduces a Quickstart guide (`user/quickstart.md`) for new/beginner users, following a linear, example-oriented format. - Demonstrates local simulation setup using GUI and CLI - Covers `.gmy` file generation, XML configuration, and HemeLB execution - Includes post-processing instructions using `hlb-dump-extracted-properties`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I updated the documentation system and documentation content:
1. Fixed typos here and there.
2. Documentation Enhancements
README.mdandXmlConfiguration.md, including:doc/user/machine-specific-build-notes/darwin.md, detailing build instructions for the University of Delaware HPC system named DARWIN.doc/user/quick-start.md.3. ReadTheDocs Website Configuration
mkdocs.yml,mkdocs-requirements.txt,.readthedocs.yamlfor Read the Docs integration.The documentation is now available at https://hemelb.readthedocs.io/en/docs/.
Upon merge of this PR, I intend to transfer the Read the Docs configuration access to a core maintainer to support long-term maintainability. Please note that the current Read the Docs project is linked to my personal fork.
Please advise if further changes are needed. Thanks.