inbo / inbo/tutorials

binary images (general strategy; also in html exports)

Open
#348 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug help wanted
Dominant language
HTML
Stars
24
Forks
10
Avg merge
2d 32m
Merged PRs (30d)
2

Description

The brms tutorial is provided by knitting html files locally and uploading them in a static folder.

However, knitting Rmd's will include binary sections for the images.
Screenshot_2024-11-26_13-22-47

This causes severe overhead for git each time the tutorial receives changes and has to be re-run.

  • We should find a better solution to host html files like this.
  • Alternatively, store images in a static folder so that they don't get changed all the time (requires manual image linking).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the brms tutorial, its Rmd source, and the static folder, then inspect how local knitting produces HTML exports and embedded binary image sections. Compare the proposed hosting and static-image alternatives; done means selecting and documenting a strategy that preserves the tutorial output without repeated binary changes in Git.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, r
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.