rust-unofficial/awesome-rust

Replace node toc lint with a Rust one

Open

#1328 opened on Jul 31, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (57,289 stars) (3,353 forks)batch import
help wanted

Description

Steps:

  1. Fix https://github.com/pbzweihander/markdown-toc/issues/2 and possibly other things there so it can replace ToC blocks in markdown
  2. Replace lint-markdown-toc with the Rust markdown-toc

Contributor guide

Tech stack
rustnodejs
Domain
ci cdtooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust basicsGitHub Actionsmarkdown parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
First, address the linked issue in the markdown toc repo (pbzweihander/markdown toc#2) to ensure the Rust tool can replace ToC blocks. Then, modify the lint.yml workflow in awesome rust (currently at .github/workflows/lint.yml line 32) to replace the Node.js lint markdown toc with the Rust based markdown toc. Review existing comments for any blockers or guidance.