PerlDancer / PerlDancer/Dancer2

Add "typical" mistakes to documentation

Open
#1,133 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Up for grabs
Dominant language
Perl
Stars
604
Forks
288
Avg merge
1d 5h
Merged PRs (30d)
5

Description

E.g. for configuration:

  • Duplicate keys
  • Typo in keys
  • Change in config.yml overridden by environments

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

Start by locating the configuration documentation and the config.yml examples or references. Add guidance covering duplicate keys, key typos, and environment overrides, then verify that the documentation clearly explains these typical mistakes.

Written by the indexing model from the issue text.

Assessment

Tech stack
perl
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.