crawler-commons/url-frontier

Add markdown-based documentation

Closed

#202 opened on Aug 18, 2026

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)Java (12 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (63 stars)
PR merge metrics
 (Avg merge 16h 28m) (39 merged PRs in 30d)

Description

it would be good to have a simple markdown-based documentation (like the one in SPRUCE) and have that running on github pages. Would make it easier for users to work out what the project is about etc...

What little content we have on the wiki could then be removed.

Contributor guide

Research direction
Explore the repository layout to determine where to place Markdown documentation, and research how to publish it on GitHub Pages. Also review the current wiki to see what content needs to be migrated.
Tech stack
java
Domain
documentation
Issue type
Documentation
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75