Contributing to the FrayedEnds Website

code

Quarto Setup

This website is built using Quarto. Please install Quarto by following the instructions on the official website.

  • Installation: https://quarto.org/docs/get-started/
  • Quarto basics: https://quarto.org/docs/get-started/hello/rstudio.html

Environment Setup

The Python environment and all dependencies are defined in the project repository. Please follow the instructions in the repository README.md (section Installation) to set up the environment.

After setting up the environment, you can run the website locally with:

quarto preview

Make sure to run this command from the docs directory.

Contributing Tutorials

Tutorial pages must be created as .ipynb or Quarto (.qmd) files in a dedicated subfolder within the tutorials directory of the repository. Within the tutorial file, the following HTML parameters can be placed in a separate Markdown cell at the top, before the actual content begins:

Begin and end this section with three hyphens (—)

title: "Any titel"
author: "Your full name"
date: "yyyy-mm-dd"
categories: [code]
image: "Preview_Image.png"
image-width: "1cm"
image-height: "1cm"
format:
    html:
        code-fold: false
        eval: false
        toc: true

Submitting a Pull Request

  • Create a fork of the main FrayedEnds repository on your Github account.
  • Before submitting your contribution, make sure your fork is up to date with the main repository.
  • Navigate to the tutorials directory and create a new subfolder named after your tutorial (e.g. my_tutorial/). This folder should contain your .ipynb or .qmd file, as well as any additional resources such as images. Please also include a preview.png file, which will be used as the cover image on the tutorials page.
  • Once your contribution is ready, open a pull request against the main repository.

If you plan to introduce major changes to the core library, please contact us in advance to avoid potential conflicts.

If you have used FrayedEnds in your research, we warmly welcome contributions of new tutorials showcasing your methods or algorithms.