juspay/nix-health

Use Markdown for health check suggestions

Open

#30 opened on Aug 15, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (4 forks)github user discovery
good first issue

Repository metrics

Stars
 (47 stars)
PR merge metrics
 (PR metrics pending)

Description

For "suggestions" we currently use String,

https://github.com/juspay/nix-browser/blob/24d41410b017be10d1fe94c641301ef1a348d1ed/src/nix/health/report.rs#L22-L29

We should change this to use a Markdown type, and correspondingly render the Markdown on the frontend.

There is https://github.com/rambip/leptos-markdown we can use for this.

Contributor guide

Research direction
Examine the current String usage for suggestions in src/nix/health/report.rs, then define a Markdown type (e.g., using the `markdown` crate) and update the struct. On the frontend, integrate a markdown renderer (e.g., leptos markdown) to display the content. Verify that suggestions render correctly.
Tech stack
rust
Domain
backendfrontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75