Skip to content

readthedocs URL change #1503

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.

Sign up for GitHub

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

Merged
chapman39 merged 3 commits into from
Dec 15, 2025
Merged

readthedocs URL change #1503

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df00b2b
readthedocs URL change
chapman39 Dec 11, 2025
d4dc5a5
Update src/docs/index.rst
chapman39 Dec 11, 2025
3459d41
Merge branch 'develop' into task/chapman39/rebuild-docs
chapman39 Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# <img src="/share/smith/logo/smith-logo-orange.png?raw=true" width="150" alt="Smith"/>

[![Build Status](https://github.com/LLNL/smith/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/LLNL/smith/actions/workflows/unit-tests.yml)
[![Documentation Status](https://readthedocs.org/projects/serac/badge/?version=latest)](https://serac.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/serac/badge/?version=latest)](https://llnlsmith.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/LLNL/serac/branch/develop/graph/badge.svg?token=DO4KFMPNM0)](https://codecov.io/gh/LLNL/serac)
[![License](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](./LICENSE)

Expand All @@ -15,9 +15,9 @@ It also heavily leverages the [MFEM finite element library](https://mfem.org/).
Documentation
------

Build, run, and design documentation can be found at [readthedocs](https://serac.readthedocs.io).
Build, run, and design documentation can be found at [readthedocs](https://llnlsmith.readthedocs.io).

Source documentation can be found [here](https://serac.readthedocs.io/en/latest/doxygen/html/index.html).
Source documentation can be found [here](https://llnlsmith.readthedocs.io/en/latest/doxygen/html/index.html).

Contributions
-------------
Expand Down
6 changes: 3 additions & 3 deletions src/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
Smith
=======

Smith is a 3D implicit nonlinear thermal-structural simulation code. Its primary purpose is to investigate multiphysics abstraction
strategies and implicit finite element-based algorithm development for emerging computing architectures. It heavily leverages the
`MFEM finite element library <https://mfem.org/>`_.
Smith, formerly known as Serac, is a 3D implicit nonlinear thermal-structural simulation code. Its primary purpose is to
investigate multiphysics abstraction strategies and implicit finite element-based algorithm development for emerging
computing architectures. It heavily leverages the `MFEM finite element library <https://mfem.org/>`_.
Copy link
Collaborator

@tupek2 tupek2 Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You know, our primary purpose has evolved a bit. This is all certainly true, but a big focus is also now on "differentiable multi-mechanics." Brandon should weight in, but I'm going to suggest:

Its primary purpose is to investigate multi-mechanics abstractions and solver strategies on emerging computing architectures, as well abstractions for differentiable multi-mechanics for both static and dynamic applications.

Copy link
Collaborator

@tupek2 tupek2 Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest merge as is, but a future thing might be to make some of the wording here more up to date with the current focuses. (its not wrong, just missing some emphasis)

Copy link
Member

@btalamini btalamini Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that the wording is stale. This is true for a lot of the docs at this point. Let's get the new site up and running and tacklie doc improvement in our goals for this year.

Copy link
Collaborator Author

@chapman39 chapman39 Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created an issue #1508


.. note::
This project is under heavy development and is currently a pre-alpha release. Functionality and interfaces may change rapidly
Expand Down
2 changes: 1 addition & 1 deletion src/docs/sphinx/dev_guide/macmini.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ how to do this, instructions can be found on
7. **Install Smith**

You're now able to clone Smith and get started with the installation process. Further instructions for doing so are currently on
the `quickstart page <https://serac.readthedocs.io/en/latest/sphinx/quickstart.html#quickstart-label>`_ of the Smith documentation.
the `quickstart page <https://llnlsmith.readthedocs.io/en/latest/sphinx/quickstart.html#quickstart-label>`_ of the Smith documentation.

----------------
Cron Job Example
Expand Down