LLM Guidelines Website

This website is built using Jekyll, Just the Docs, and GitHub Pages. Changes are made to Latex files, which are then converted to Markdown and rendered on the website.

Local testing

You can test changes to the website locally as follows:

1. Either install ruby and pandoc directly or using asdf (see .tool-versions). If you're on Windows, we suggest using WSL.
2. Run gem install bundler jekyll.
3. Run bundle install in the root directory of this repo.
4. Run ./convert-and-merge-sources.sh to convert the Latex files to Markdown.
5. Run bundle exec jekyll serve to host the website locally.
6. Open http://localhost:4000/ in your browser.

When you change the Latex and convert them to Markdown, the local version of the website will automatically refresh (this does not apply to changes in the configuration, which you as a contributor usually don't need to modify). Do not modify the converted Markdown files, as your changes will be lost after the next conversion. The converted files are also not versioned, as they are generated when the website is deployed using a GitHub Actions workflow (see below).

Once you push your changes to the main branch or once a pull request is merged, the website is automatically redeployed via a GitHub Actions workflow, which you can monitor here.

We are free to use any Latex editor you like. To double-check the generated Markdown files, you can use any Markdown editor you like, preferably one that supports kramdown, which is the default Markdown renderer for Jekyll.

If you add references to literature.bib, please use the DBLP Bibtex entries, if available.

Information for authors

• Check our custom commands which are included in all Latex files using header.tex. Use \todo{} to keep track of to-dos and \comment{} for review feedback. For recommendations, use the commands based on RFC 2119, which are defined in the same header file.
• Before adding new references to literature.bib, check whether a reference already exists (e.g., by searching for parts of the title).
• Always use the dblp bibtex entries if available.
• Before pushing your changes, validate locally whether the modified Latex files compile.
• We reference study types from the guidelines, not the other way around. If you want to connect study types and guidelines, consider updating the study type subsection of the corresponding guideline.
• Direct pushes to the main branch are not possible anymore. Please use branches and pull requests.
• Reference from literature.bib can be cited using the standard Latex \cite{} command. To refer to other sections of our study types and guidelines, you cannot use the standard Latex approach (\label{} and \ref{}) because those references would not be correctly rendered by our pipeline. You need to use \href{}{} with a relative path and anchor (see this example).