docs(paper): clarify paragraphs in paper + add compilation guidelines#122
Merged
Neclow merged 2 commits intosbhattlab:mainfrom Sep 29, 2025
Merged
docs(paper): clarify paragraphs in paper + add compilation guidelines#122Neclow merged 2 commits intosbhattlab:mainfrom
Neclow merged 2 commits intosbhattlab:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation for the JOSS paper submission by clarifying content and providing compilation guidelines. The changes address feedback from issue #121 by improving clarity in the paper's content and adding practical guidance for compiling and word-counting the submission.
- Clarified the Figure 1 caption to fix technical specifications and improve readability
- Simplified feature descriptions in the paper content to be more concise
- Abbreviated journal names in the bibliography to meet page constraints
- Added comprehensive compilation instructions and a word count utility script
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| joss/src/wordcount.rb | New Ruby script for counting words in paper files, adapted from OpenJournals' buffy service |
| joss/paper.md | Updated figure caption and simplified feature descriptions for clarity |
| joss/paper.bib | Abbreviated journal names to standard formats for space efficiency |
| joss/jats/paper.jats | Corresponding updates to the JATS XML format reflecting paper content changes |
| joss/README.md | New documentation with Docker-based compilation instructions and word count guidance |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #121
openjournals/joss-reviews#9040