[DOC]: Provide a thorough description on how junifer works #39

Merged

synchon merged 18 commits from docs/junifer-working into main

2022-10-26 07:19:24 +00:00

synchon commented

2022-10-24 11:54:21 +00:00

(Migrated from github.com)

Which element of the documentation do you want to modify and why?

The documentation lacks a description on how junifer works.

This should include a diagram of the pipeline and what are the different parts of it.

Anything else to say?

No response

### Which element of the documentation do you want to modify and why? The documentation lacks a description on how junifer works. This should include a diagram of the pipeline and what are the different parts of it. ### Anything else to say? _No response_

github-actions[bot] commented

2022-10-24 11:58:31 +00:00

(Migrated from github.com)

PR Preview Action v1.2.0
Preview removed because the pull request was closed.
2022-10-26 07:24 UTC

[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.2.0 :---: Preview removed because the pull request was closed. 2022-10-26 07:24 UTC

codecov[bot] commented

2022-10-24 12:02:52 +00:00

(Migrated from github.com)

Codecov Report

Merging #39 (3101f87) into main (7fca9fd) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #39   +/-   ##
=======================================
  Coverage   87.94%   87.94%           
=======================================
  Files          50       50           
  Lines        1925     1925           
  Branches      356      356           
=======================================
  Hits         1693     1693           
  Misses        185      185           
  Partials       47       47

# [Codecov](https://codecov.io/gh/juaml/junifer/pull/39?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#39](https://codecov.io/gh/juaml/junifer/pull/39?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (3101f87) into [main](https://codecov.io/gh/juaml/junifer/commit/7fca9fd787f1168cdc340dfb79efa8f039fc6e09?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (7fca9fd) will **not change** coverage. > The diff coverage is `n/a`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/39/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/39?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #39 +/- ## ======================================= Coverage 87.94% 87.94% ======================================= Files 50 50 Lines 1925 1925 Branches 356 356 ======================================= Hits 1693 1693 Misses 185 185 Partials 47 47 ```

synchon commented

2022-10-25 12:38:07 +00:00

(Migrated from github.com)

@fraimondo Maybe we add the diagram later?

fraimondo (Migrated from github.com) approved these changes

2022-10-26 07:18:27 +00:00