Skip to content

Refine documentation #12972

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

Merged
merged 8 commits into from
Apr 21, 2025
Merged

Refine documentation #12972

merged 8 commits into from
Apr 21, 2025

Conversation

koppor
Copy link
Member

@koppor koppor commented Apr 20, 2025

Preparation for the multi-project build

Move getting-into-the-code/* into either /index.md or code-howtos/*

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [.] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [.] Tests created for changes (if applicable)
  • [.] Manually tested changed features in running JabRef (always required)
  • [.] Screenshots added in PR description (if change is visible to the user)
  • [.] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • [.] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor requested a review from subhramit April 20, 2025 17:54

During development, one can configure IntelliJ to pass command line parameters:
Binaries are created using [gradle](https://gradle.org) and are uploaded to [https://builds.jabref.org](https://builds.jabref.org).
These binaries are created without any checks to have them available as quickly as possible, even if the localization or some fetchers are broken.
Copy link
Member

@subhramit subhramit Apr 21, 2025

Choose a reason for hiding this comment

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

Binaries are created at builds.jabref.org

  1. In case of upstream branches
  2. In case of merged pull requests

"1" is not generally followed by contributors. "2" contradicts "without any checks".
Maybe need some more clarity here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I did a minimal update there.

@subhramit
Copy link
Member

Review 11fcb9b.

Copy link

trag-bot bot commented Apr 21, 2025

@trag-bot didn't find any issues in the code! ✅✨

@koppor koppor added the automerge PR is tagged with that label will be merged if workflows are green label Apr 21, 2025
@koppor koppor enabled auto-merge April 21, 2025 08:37
@koppor koppor added this pull request to the merge queue Apr 21, 2025
Copy link
Contributor

github-actions bot commented Apr 21, 2025

The build for this PR is no longer available. Please visit https://builds.jabref.org/main/ for the latest build.

Merged via the queue into main with commit 4916a01 Apr 21, 2025
2 checks passed
@koppor koppor deleted the restructure-doc branch April 21, 2025 09:00
luks-santos pushed a commit to luks-santos/jabref that referenced this pull request Apr 22, 2025
* Refine grammar in README.md

* Fix grammar

* Move FAQ to FAQs

* Move getting-into-the-code/* into either /index.md or code-howtos/*

* Fix markdown

* Re-refinement

* Fix link

* Refine builds information

---------

Co-authored-by: Subhramit Basu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge PR is tagged with that label will be merged if workflows are green
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants