Skip to content

Conversation

@PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Nov 8, 2022

No description provided.

@PProfizi PProfizi added the documentation Improvements or additions to documentation label Nov 8, 2022
@PProfizi PProfizi self-assigned this Nov 8, 2022
@codecov
Copy link

codecov bot commented Nov 8, 2022

Codecov Report

Merging #607 (8a23434) into master (be8d22d) will decrease coverage by 1.85%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #607      +/-   ##
==========================================
- Coverage   87.90%   86.05%   -1.86%     
==========================================
  Files          68       68              
  Lines        7566     7566              
==========================================
- Hits         6651     6511     -140     
- Misses        915     1055     +140     

Copy link
Contributor

@GuillemBarroso GuillemBarroso left a comment

Choose a reason for hiding this comment

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

I have seen in other repos that the README is included as the first page of the documentation. Maybe we could also do this here? So we avoid to have "duplicated" documentation?

@PProfizi
Copy link
Contributor Author

PProfizi commented Nov 9, 2022

I have seen in other repos that the README is included as the first page of the documentation. Maybe we could also do this here? So we avoid to have "duplicated" documentation?

Right now the two do not have the same structure. We might do this in the future but this is not a priority right now.

@PProfizi PProfizi merged commit 0b40142 into master Nov 9, 2022
@PProfizi PProfizi deleted the doc/update_readme_dev_install_command branch November 9, 2022 09:02
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants