nushell/nu_scripts

Automatic TOC generation

Open

#4 opened on Jan 23, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Nushell (321 forks)auto 404
help wanted

Repository metrics

Stars
 (1,268 stars)
PR merge metrics
 (Avg merge 11h 25m) (1 merged PR in 30d)

Description

Just to log the discussion from #1 here.

Would be good to have a) a table of contents listing all scripts, b) some system to generate it automatically so we don't have to update it manually.

Contributor guide

Research direction
Explore the repository structure and identify a method to generate a TOC automatically. This could involve writing a Nushell script that recursively finds all .nu files and generates Markdown links. Check if there are any existing tools or scripts in the repo.
Tech stack
shell
Domain
clitooling
Issue type
Feature
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.
Half day
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
GitNushell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50