Conversation
pelesh
added
documentation
shakedregev
reviewed
Aug 12, 2025
shakedregev
approved these changes
Aug 12, 2025
Collaborator
shakedregev
left a comment
shakedregev
left a comment
There was a problem hiding this comment.
This looks good and it is far ahead of develop. Even if it's not perfect, I say we merge it.
shakedregev
force-pushed
the
frontmatter-dev
branch
from
48f7604 to
8cb638f
Compare
pelesh
force-pushed
the
frontmatter-dev
branch
from
aea72be to
1cc3f69
Compare
Added details about implicit coding guidelines that were not specified. Added suggested branching workflow. Added PR reviewing and opening and issue guidelines. Fixed typos Restructured documentation sections Co-authored-by: pelesh <peless@ornl.gov>
Updated links in README to pint to readthedocs pages generated from `frontmatter-dev` branch. This needs to be reverted before merging.
--------- Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: Slaven Peles <peless@ornl.gov>
pelesh
force-pushed
the
frontmatter-dev
branch
from
00742dc to
f82249c
Compare
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
2 participants
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.
Description
The documentation at readthedocs.io fell behind Re::Solve development. It would be helpful to review the online documentation and update it as needed.
@nkoukpaizan @shakedregev
Closes #214.
Closes #298.
Proposed changes
This is draft PR to review outstanding actions on documentation updates.
These include:
Preview changes here.
Checklist
-Wall -Wpedantic -Wconversion -Wextra.Further comments