Skip to content

Frontmatter dev #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 30 commits into
base: develop
Choose a base branch
from
Draft

Frontmatter dev #266

wants to merge 30 commits into from

Conversation

pelesh
Copy link
Collaborator

@pelesh pelesh commented May 12, 2025

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

Proposed changes

This is draft PR to review outstanding actions on documentation updates.

These include:

  • Update user and developer documentation.
  • Ensure developer guidelines are in sync with clang-format configuration.
  • Create links at the landing page README to main topics in the documentation.
  • Add Re::Solve logos

Preview changes here.

Checklist

  • All tests pass. Code tested on
    • CPU backend
    • CUDA backend
    • HIP backend
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
  • The new code follows Re::Solve style guidelines.
  • There are unit tests for the new code.
  • The new code is documented.
  • The feature branch is rebased with respect to the target branch.

Further comments

@pelesh pelesh added this to the Release 0.99.2 milestone May 12, 2025
@pelesh pelesh requested review from maksud and kswirydo May 12, 2025 14:34
@pelesh pelesh self-assigned this May 12, 2025
@pelesh pelesh added documentation Improvements or additions to documentation enhancement New feature or request labels May 12, 2025
@pelesh pelesh force-pushed the frontmatter-dev branch from fe18d34 to dde06f8 Compare May 12, 2025 21:00
@pelesh pelesh force-pushed the frontmatter-dev branch from ec7f8cd to 0b7d635 Compare June 21, 2025 02:08
@pelesh pelesh force-pushed the frontmatter-dev branch from cc40cb9 to 9675b5c Compare June 28, 2025 04:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants