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

Documentation #62

Open
srosenbu opened this issue Aug 14, 2024 · 1 comment
Open

Documentation #62

srosenbu opened this issue Aug 14, 2024 · 1 comment

Comments

@srosenbu
Copy link
Member

We should start writing the docs for this repo. I started a documentation in NFDI4IngModelValidationPlatform and I am quite happy with the setup. I can just copy the basic files and then @saifr68 can start writing docs for the stress-rate implementatoin and I can start with the conventions for the models (Like gradients of vectors, order of stress components, etc.).

Do we want documentaion for the models or do we wait until we have decided how to continue with the repos? @aradermacher

@joergfunger
Copy link
Member

The setup looks great and is a good starting point for a future documentation. However, I would wait until we have decided on howto proceed with the individual repos.

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