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.

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

Implement JOSS reviewer suggestions: Docs landing page & README #138

Merged
merged 15 commits into from
Feb 19, 2025

Conversation

jschepers
Copy link
Collaborator

@jschepers jschepers commented Feb 6, 2025

This PR implements the JOSS reviewer suggestions from @cbrnr. Thanks a lot again for your suggestions!

  • We added the statement of need section to the README.md file and the landing page of the documentation.
  • We added an installation instruction page to the documentation (based on the Unfold.jl documentation page, thanks @behinger)
  • We added a developer documentation page to the package docs which includes instructions regarding unit tests (and also information about the development workflow, formatting, and documentation)

Additionally, we revised the docs landing page and the README.md.

@jschepers
Copy link
Collaborator Author

jschepers commented Feb 19, 2025

@behinger Please have a final look. If you have no objections, I will merge.
https://unfoldtoolbox.github.io/UnfoldSim.jl/previews/PR138/

@jschepers jschepers merged commit a115f8e into main Feb 19, 2025
4 checks passed
@jschepers jschepers deleted the implement-reviewer-suggestions branch February 19, 2025 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant