-
Couldn't load subscription status.
- Fork 1
docs: paper #111
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
Open
cmeesters
wants to merge
20
commits into
main
Choose a base branch
from
docs/paper
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docs: paper #111
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
06af3bd
docs: first paper draft
cmeesters fc60051
docs: first round with hopefully working bibliography
cmeesters f129380
docs: added github action to typeset draft
cmeesters 37dc5bc
fix: corrected metadata section
cmeesters 034c11a
fix: syntax
cmeesters ee3886f
fix: syntax
cmeesters db39ed1
Update paper/paper.md
cmeesters 7687119
fix: upload path
cmeesters 89ad961
docs: added rulegraph for paper - not the final version
cmeesters 02e471f
fix: corrected orcid for L. Hellman
cmeesters 807de9f
fix: citation ids
cmeesters 0473983
fix: minor fixes
cmeesters 45f4e48
fix: remade boken rulegraph
yeising 4af47cc
style: term consistency
yeising 322dc0e
fix: small fixes
yeising a59abb6
refactor: removed unused library references
yeising 3e49cd7
docs: removed unused references from bibiliography and updated remain…
yeising d94f12e
docs: added Usage section, extended workflow example section, minor d…
yeising 946bb52
feat: added Christiane's ORCID
cmeesters 4ab1a2f
docs: added usage comments
cmeesters File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: Draft PDF | ||
| on: | ||
| push: | ||
| paths: | ||
| - paper/** | ||
| - .github/workflows/draft-pdf.yml | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| paper-path: paper/paper.md # Path to the paper within your repo | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: paper | ||
| path: paper/paper.pdf # Output path where Pandoc writes the compiled PDF | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Jobs Block: Correct Indentation
The
jobssection also shows inconsistent indentation. For instance, line 9 (the keypaper:) is indented with 2 spaces while the expected indentation is 4, and line 10’sruns-on: ubuntu-latestshould be indented by 6 spaces rather than 4.A consistent reindentation might look like this:
Adjust the rest of the document similarly to maintain uniformity.
🧰 Tools
🪛 YAMLlint (1.35.1)
[warning] 9-9: wrong indentation: expected 4 but found 2
(indentation)
[warning] 10-10: wrong indentation: expected 6 but found 4
(indentation)