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

Feature/doc md #208

Open
wants to merge 67 commits into
base: feature/doc_md
Choose a base branch
from
Open

Feature/doc md #208

wants to merge 67 commits into from

Conversation

yojvr
Copy link
Member

@yojvr yojvr commented Apr 8, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Docs

What is the current behavior?

Same as the forked 'main' branch.

What is the new behavior (if this is a feature change)?
Introducing markdown documentation (especially concerning install, launching, I/O, global algorithm, METRIX model and mathematical model).

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

What changes might users need to make in their application due to this PR? (migration steps)

Other information:

This documentation's version is neither exhaustive nor validated.

@yojvr yojvr requested a review from rolnico April 8, 2025 13:14
@yojvr yojvr force-pushed the feature/doc_md branch 6 times, most recently from 7ebbf92 to b30eef9 Compare April 8, 2025 14:45
[YJ] signoff

Signed-off-by: Yoann Janvier <[email protected]>
This reverts commit bf881b6.

Signed-off-by: Yoann Janvier <[email protected]>
[YJ] doc as md

Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
Signed-off-by: Yoann Janvier <[email protected]>
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