gpujs/gpu.js

Better looking natural docs

Open

#19 opened on Feb 28, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (756 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (14,837 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This: http://gpu.rocks/getting-started/

is over 9000 times better then

This: http://gpujs.github.io/dev-docs/

Problem is the former is manually created, the later is generated.

And so far from every JS documentation engine i use, they have quirks, or something off about it. NaturalDocs for all its "old-fashion" looks, works.

Basically we need to replace this or fix it.

Contributor guide

Research direction
Investigate the current documentation generation pipeline in the repository. Look at the docs/ directory and any documentation config files. Compare the manually created docs at http://gpu.rocks/getting started/ with the generated ones at http://gpujs.github.io/dev docs/ to identify specific styling differences. Consider using a newer documentation tool or customizing the existing one. Check issue comments for previous suggestions.
Tech stack
javascripthtmlcss
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.
Half day
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.
Unclear
Prerequisites
HTMLCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40