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

Improve readme and documentation #45

Merged
merged 13 commits into from
Dec 11, 2023
Merged

Improve readme and documentation #45

merged 13 commits into from
Dec 11, 2023

Conversation

geek-yang
Copy link
Member

@geek-yang geek-yang commented Nov 17, 2023 •
edited
Loading

Improve readme and documentation of zampy:

  • Restructure readme and add more practical information
  • Polish the documentation (mkdocs)
  • Add contributing doc
  • Add code of conduction
  • Add developer guide
  • Add (empty) CHANGELOG
  • Add acknowledgement info

Note that this PR is future proof for the v1.0 release of zampy.

@review-notebook-app Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@geek-yang
Copy link
Member Author

Shall we add the logo #39 to the docs? Does everyone agree @BSchilperoort @SarahAlidoost ?

@geek-yang geek-yang marked this pull request as ready for review November 20, 2023 15:06
BSchilperoort
BSchilperoort requested changes Nov 22, 2023
View reviewed changes
Copy link
Contributor

@BSchilperoort BSchilperoort left a comment

Choose a reason for hiding this comment

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

Thanks for taking this up Yang! I have a couple of questions/comments/suggestions 😄

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/README.dev.md Outdated Show resolved Hide resolved
docs/README.dev.md Show resolved Hide resolved
docs/README.dev.md Outdated Show resolved Hide resolved
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/README.dev.md Show resolved Hide resolved
@geek-yang geek-yang mentioned this pull request Nov 29, 2023
Open
@geek-yang
Copy link
Member Author

Thanks a lot for the suggestions @BSchilperoort ! I address all the comments and this PR is ready for review again. 😄

BSchilperoort
BSchilperoort approved these changes Dec 4, 2023
View reviewed changes
Copy link
Contributor

@BSchilperoort BSchilperoort left a comment

Choose a reason for hiding this comment

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

Just some last comments from me.

The CI seems to have failed on one test (timeout) but that's unrelated to the changes in this PR.

docs/CONTRIBUTING.md Show resolved Hide resolved
docs/available_datasets.md Show resolved Hide resolved
docs/available_datasets.md Show resolved Hide resolved
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Dec 8, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@geek-yang geek-yang merged commit 7ad91da into main Dec 11, 2023
10 of 12 checks passed
@geek-yang geek-yang deleted the improve_documentation branch December 11, 2023 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BSchilperoort BSchilperoort BSchilperoort approved these changes

@SarahAlidoost SarahAlidoost Awaiting requested review from SarahAlidoost

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@geek-yang @BSchilperoort