documentcloud / documentcloud/underscore-contrib

Improve design of docs

Open
#223 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
622
Forks
114
PR merge metrics
No merged PRs in 30d

Description

The docs are in need of some design improvements in the following areas:

  • Mobile friendly responsive layout
  • A visual refresh
  • Incorporating some sort of method search, similar to what is on the Underscore docs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the existing documentation layout and the current method-navigation experience; define the responsive layout, visual refresh, and method search scope before making changes. Done means the docs address all three requested areas.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.