Skip to content

Create a general R2D2 documentation#727

Open
ftgoktas wants to merge 7 commits intodevelopfrom
docs/r2d2_v3
Open

Create a general R2D2 documentation#727
ftgoktas wants to merge 7 commits intodevelopfrom
docs/r2d2_v3

Conversation

@ftgoktas
Copy link
Copy Markdown
Member

@ftgoktas ftgoktas commented Mar 6, 2026

Description

WIP – documenting R2D2 and its use within Swell.

You can refer: https://github.com/GEOS-ESM/swell/blob/docs/r2d2_v3/docs/examples/r2d2_intro.md

To preview the updated Swell website: cd docs && python -m http.server 3000, then open http://localhost:3000.

Any comments and suggestions welcome!

@ftgoktas ftgoktas added the r2d2 label Mar 6, 2026
@ftgoktas ftgoktas linked an issue Mar 6, 2026 that may be closed by this pull request
@ftgoktas ftgoktas removed a link to an issue Mar 6, 2026
@ftgoktas ftgoktas linked an issue Mar 6, 2026 that may be closed by this pull request
@Dooruk Dooruk requested review from DavidSRussell March 11, 2026 19:15
mranst
mranst previously approved these changes Mar 26, 2026
Copy link
Copy Markdown
Collaborator

@mranst mranst left a comment

Choose a reason for hiding this comment

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

Looks good! This should be very helpful for users

@ftgoktas ftgoktas marked this pull request as ready for review April 2, 2026 20:20
Copy link
Copy Markdown
Contributor

@jeromebarre jeromebarre left a comment

Choose a reason for hiding this comment

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

A good documentation. A few little changes, see my comments.

Comment thread docs/_sidebar.md Outdated
Comment thread docs/creating_an_experiment.md Outdated
Comment thread docs/examples/r2d2_intro.md Outdated
@mranst mranst requested a review from jeromebarre May 8, 2026 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

R2D2 docs

3 participants