afeld/tangle

support scanning of a local directory

Open

#7 opened on Jun 7, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (0 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Depends on #6.

If the path to a local HTML file is given, it should be scanned. If the path to a local directory is given, it should

  • Scan all HTML files therein, or
  • Scan recursively from the index.html (depends on #4), and report any orphaned pages

Not sure which is preferable. Either case would be helpful for checking the output of static site generators.

Contributor guide

Research direction
Review the existing scanning logic for HTML files, then implement directory traversal to scan all HTML files or recursively from index.html. Consider the two approaches and discuss in the issue.
Tech stack
go
Domain
cli
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.
1-2 days
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.
Mostly clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65