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] Update Readme and regroup all documentation in md files #123

Merged
merged 24 commits into from
Jan 10, 2024

Conversation

epernod
Copy link
Contributor

@epernod epernod commented Dec 27, 2023

This PR remove a lot of old documentation files and regroup all info from .md, .pdf and .doc directly into the Readme and linked .md files.
Important: This PR just reorder the documents. I did not yet updated the doc.

Hard to see in the PR. Best to directly go to the branch links below

@epernod epernod added documentation Improvements or additions to documentation pr: clean pr: status to review To notify reviewers to review this pull-request labels Dec 27, 2023
@epernod epernod requested review from fredroy and hugtalbot December 27, 2023 15:09
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
@hugtalbot
Copy link
Contributor

Awesome @epernod 👍
I made a lot of minor remarks let me know if you want me to do the changes

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@epernod epernod requested a review from hugtalbot January 4, 2024 21:31
doc/README.md Outdated

### Introduction
## 1. Introduction

The plugin Beam Adpater allows to have a dynamic implementation of the FEM beam elements.
The underlying mechanical fundations are based on beam theory (https://en.wikipedia.org/wiki/Euler–Bernoulli_beam_theory), that have been extended to large transformation using corotational formualation.
Copy link
Contributor

Choose a reason for hiding this comment

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

"formulation"

Copy link
Contributor

Choose a reason for hiding this comment

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

Et je croyais que c'était la formulation de Timoshenko

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I copy past it from one of the file in the doc. might be not related to the plugin sorry.
We can remove it.

@hugtalbot hugtalbot merged commit 76ca5a6 into sofa-framework:master Jan 10, 2024
3 checks passed
@epernod epernod deleted the inf_readme branch January 10, 2024 15:33
@epernod epernod added pr: status ready Approved a pull-request, ready to be squashed and removed pr: status to review To notify reviewers to review this pull-request labels Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pr: clean pr: status ready Approved a pull-request, ready to be squashed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants