Skip to content

updated high level documentation #154

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

benjaminleighton
Copy link
Collaborator

Hi @tomdurrant , I've done some automated analysis and semi automated edits to some of the high level documentation. I think this brings it more in line with the current capabilities of rompy. What do you think?

@tomdurrant
Copy link
Collaborator

tomdurrant commented Apr 11, 2025

HI @benjaminleighton - content looks good, but you are building these with references to xbeach, which is an external package. We can of course add it to the docs requirements, but we may want to think this through a little more. The options as I see them are

  1. have all rompy docs combined into rompy-core (what this repo will ultimately become). Add all models as depdencies.
  2. Have only core docs in here, and have model specific docs in a each respective repo
  3. Some sort of dedicated docs repo.

We can probably leave that discussion until we are a bit further down the line of the model separation. For now, I suggest we remove xbeach references from the docs in this repo....?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants