Skip to content
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

G+Smo Adapter Documentation on preCICE Website #482

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

Crazy-Rich-Meghan
Copy link

@Crazy-Rich-Meghan Crazy-Rich-Meghan commented Dec 27, 2024

Hello,

This PR is the documentation for the G+Smo adapter.

@Crazy-Rich-Meghan Crazy-Rich-Meghan marked this pull request as ready for review January 6, 2025 08:47
Copy link
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution here! Let me first try out the tutorials and iterate there. Once the tutorials are merged, let's continue here.

You also have some documentation here: https://github.com/gismo/gsPreCICE
It could be good to reduce such duplication from the beginning. You could create a docs folder in your repo and move the pages from this PR to there. Then, we include the adapter is a submodule in the website repo. This is also how we handle other adapter docs (e.g. the OpenFOAM adapter docs). I am happy to help with this.

pages/docs/adapters/adapter-overview.md Outdated Show resolved Hide resolved
pages/docs/adapters/gismo/adapter-gismo-get-adapter.md Outdated Show resolved Hide resolved
pages/docs/adapters/gismo/adapter-gismo-get-adapter.md Outdated Show resolved Hide resolved
pages/docs/adapters/gismo/adapter-gismo-overview.md Outdated Show resolved Hide resolved
pages/docs/adapters/gismo/adapter-gismo-overview.md Outdated Show resolved Hide resolved
pages/docs/adapters/gismo/adapter-gismo-overview.md Outdated Show resolved Hide resolved
Comment on lines 13 to 19
## How to get G+Smo?
The G+Smo adapter is a submodule of the G+Smo library, relies on the core functionality of the main library. To get started, you need to install G+Smo on your system first.


## Start here
1. [Get G+Smo and the adapter](adapter-gismo-get-adapter.html)
2. [Configure and run tutorial](adapter-gismo-get-adapter.html).
Copy link
Member

Choose a reason for hiding this comment

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

Let's try to remove some duplication. Short pages are good.

@Crazy-Rich-Meghan
Copy link
Author

Thanks for the contribution here! Let me first try out the tutorials and iterate there. Once the tutorials are merged, let's continue here.

You also have some documentation here: https://github.com/gismo/gsPreCICE It could be good to reduce such duplication from the beginning. You could create a docs folder in your repo and move the pages from this PR to there. Then, we include the adapter is a submodule in the website repo. This is also how we handle other adapter docs (e.g. the OpenFOAM adapter docs). I am happy to help with this.

Hi @uekerman,

For the documentation from our side, there will be some duplications anyway. Since G+Smo is using the Doxygen system which uses /doc. Would you still recommend to have /docs for G+Smo and /docs for preCICE in our submodule instead of having it here?

@Crazy-Rich-Meghan
Copy link
Author

@uekerman we removed the G+Smo documentation folder. And added everything into a single page, the page name is adapter-gismo.md.

@uekerman
Copy link
Member

I modified the README and the sidebar (locally). Could you please edit the PR setup and tick "allow edits by maintainers". Then, I could push my changes to your master branch. Or you could add me as collaborator to your fork and give write access.

@Crazy-Rich-Meghan
Copy link
Author

I modified the README and the sidebar (locally). Could you please edit the PR setup and tick "allow edits by maintainers". Then, I could push my changes to your master branch. Or you could add me as collaborator to your fork and give write access.

@uekerman I added you as the collaborator of my fork.

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.

3 participants