DOC: improvements to developers documentation #732
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #732 +/- ##
==========================================
+ Coverage 75.97% 76.03% +0.05%
==========================================
Files 99 94 -5
Lines 11255 10981 -274
==========================================
- Hits 8551 8349 -202
+ Misses 2704 2632 -72 ☔ View full report in Codecov by Sentry. |
Merged
7 tasks
…ntation, and didn't find anything to correct or improve. I think it's fine as it is. I added a model to requirements.txt, which was missing when I ran the make html command.
Gui-FernandesBR
commented
Nov 27, 2024
Gui-FernandesBR
commented
Nov 30, 2024
There was a problem hiding this comment.
Really nice work,
Than you so much for your contribution, @phmbressan , @Lucas-Prates @juliomachad0 !!
Gui-FernandesBR
added a commit
that referenced
this pull request
Nov 30, 2024
* DOC: improvements to developers documentation * MNT: git rename a few files from the root directory * DOC: more upgrades to development docs * DEV: create script to delete local branches that no longer exist on remote * DOC: I followed the step by step, looked at other parts of the documentation, and didn't find anything to correct or improve. I think it's fine as it is. I added a model to requirements.txt, which was missing when I ran the make html command. * DOC: Update developer docs on sphinx building. * DOC: Clarify testing structure on testing docs. * DOC: Re-run docs requirements freeze. * DOC: Introduce Conflicts Guideline and update First PR. * DOC: fixing typos on development docs. * DOC: Solve review comments of dev docs. * DOC: final touches to developers documentation * DOC: update cSpell configuration to enable additional file types * DEV: move docker ignore file --------- Co-authored-by: Julio Machado <julioromac@outlook.com> Co-authored-by: Pedro Bressan <phmbressan@usp.br> Co-authored-by: Lucas de Oliveira Prates <lucasdelprates@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our development documentation really needs to be updated.
The last major additions to these pages were done more than 3 years ago.
I have re-strucctured the dev docs pages, but I'd appreciate if we could split these pages among our team of developers so we can have a more diverse point of view throughout our documentation.
These are the pages that still needs to be finished and reviewed :