nunit / nunit/docs

Update images to relative paths such that they can display in GitHub as well

Open
#829 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
600
Forks
158
Avg merge
16h 8m
Merged PRs (30d)
21

Description

As @manfred-brands helpfully pointed out on #827, referencing images with a relative path means we can host them correctly in docfx and also have them show up nicely in GitHub markdown.

Seems like a win/win.

Creating this task to track the conversion of other images to relative pathing.

Contributor guide

Open the contributing guide

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 by locating image references throughout the documentation and compare them with the relative-path approach described in the issue. Convert the remaining image references and verify that the images render in both DocFX and GitHub Markdown.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.