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.

Sign up for GitHub

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

Jump to bottom

Update doc structure and dev guide #2383

Merged
merged 11 commits into from
Sep 6, 2023
Merged

Update doc structure and dev guide #2383

merged 11 commits into from
Sep 6, 2023

Conversation

maxnoe
Copy link
Member

@maxnoe maxnoe commented Jul 17, 2023

No description provided.

kosack
kosack requested changes Jul 18, 2023
View reviewed changes
docs/getting_started/index.rst Outdated Show resolved Hide resolved
docs/getting_started/index.rst Outdated Show resolved Hide resolved
docs/getting_started/index.rst Outdated Show resolved Hide resolved
docs/getting_started/index.rst Outdated Show resolved Hide resolved
docs/getting_started/index.rst Outdated Show resolved Hide resolved
@maxnoe maxnoe force-pushed the update_dev_docs branch 2 times, most recently from 4e320e5 to d803241 Compare July 19, 2023 10:30
@maxnoe maxnoe mentioned this pull request Jul 19, 2023
Merged
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@maxnoe maxnoe changed the title Update dev getting started Update doc structure and dev guide Jul 21, 2023
@maxnoe
Copy link
Member Author

maxnoe commented Jul 21, 2023

I update the structure now to follow what we discussed in #2373, specifically the comment here

#2373 (comment)

Please have a look.

The developer guide now has syncing tabs for the commands depending on whether you are on a fork or work in the main repository.

kosack
kosack previously approved these changes Aug 1, 2023
View reviewed changes
Copy link
Contributor

@kosack kosack left a comment

Choose a reason for hiding this comment

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

This structure looks much better. Thanks

@maxnoe @Tobychev
Add section on pre-commit hooks
cfc144a 
Co-authored-by: Tomas Bylund <tomas.bylund@cea.fr>
@kosack kosack merged commit 9c2d0d2 into main Sep 6, 2023
10 of 11 checks passed
@kosack kosack deleted the update_dev_docs branch September 6, 2023 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kosack kosack kosack approved these changes

@Tobychev Tobychev Tobychev approved these changes

@LukasNickel LukasNickel Awaiting requested review from LukasNickel

Assignees
No one assigned
Labels
documentation no-changelog-needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maxnoe @Tobychev @kosack @LukasNickel