How to Improve the Help Page
The easiest way to fix small errors, or to add additional information, is to edit a help page directly in your browser, using the following steps.
At the top of each help page, you can find the GitHub icon with "Edit on GitHub" link. Just click the link to show the source of the page.
This leads you to the GitHub page associated with the help page:
%20(1)%20(1)%20(1)%20(1)%20(1)%20(2)%20(3)%20(3)%20(2).png?alt=media&token=d1c8008b-a47e-49e3-9d35-1b80242ae424)
To actually edit the page, click on the pencil icon, as highlighted above.
The window to edit the page at GitHub looks like this:
%20(3)%20(3)%20(3)%20(1).png?alt=media&token=02542ead-ea62-41c9-b3e1-c624e5291905)
Edit view at GitHub
In order to review your changes, click on the "Preview changes" tab:
%20(1)%20(1)%20(1)%20(3)%20(3)%20(3).png?alt=media&token=2d8f8217-da68-499c-9f92-e2794fc781bb)
Edit view at GitHub
To save the changes, create a so-called "Commit" by scrolling down and pressing the "Propose File Change" button:
%20(2)%20(2)%20(2)%20(2)%20(3).png?alt=media)
Save changes
Please note: The message you provide here will be visible in the history of the help page, so please consider your change and provide a meaningful description of your changes.
As the last step, submit the changes you have made back to the JabRef team:
%20(3)%20(3)%20(3)%20(2).png?alt=media&token=c359ebca-84ff-47b3-885a-0532ebf4bb04)
Create Pull Request
Just press the "Create Pull Request" button, and confirm the creation of the request on the next page.
To edit more than one file at a time, add screenshots, and for other more advanced changes, we recommend that you checkout this repository locally and create a Pull Request of your changes using the standard git and GitHub workflow.
The best way to enter tables is to use this Table Generator for Markdown. It has the nice feature to generate markdown tables from different sources, e.g. you can directly copy the table from a spreadsheet or upload a csv file. Just copy and paste the generated markdown into the documentation.
Last modified 1yr ago