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

Refactor documentation and render on precice.org #2

Closed
uekerman opened this issue May 19, 2023 · 0 comments
Closed

Refactor documentation and render on precice.org #2

uekerman opened this issue May 19, 2023 · 0 comments
Milestone

Comments

@uekerman
Copy link
Member

Let's create a page in the preCICE docs under Tooling named "FMI Runner". There, we want to render documentation (could be a single page), which is, however, hosted in this repo. Compare the OpenFOAM adapter or, very recently, the Micro Manager on how this works technically, i.e. what needs to be created on the website.

https://github.com/precice/precice.github.io/pull/270/files

In this repo here, we should the actual documentation page to a subfolder docs. The main README should then only contain minimal information ("what is this", "where to find out more") and link to the website. Also, content from other README pages could be ported to the docs.

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

No branches or pull requests

2 participants