11ty / 11ty/docs

Ambiguity in language on File Passthrough docs

Open
#462 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

Let's look at clarifying the language on this page and suggesting best practice https://www.11ty.dev/docs/copy/#passthrough-all-content

Right now, a user needs to read the first 4 paragraphs to clarify the point the second paragraph makes.

I personally also wonder if the best practice should be to use addPassthroughCopy and NOT use template extensions in the way the second graf mentions it.

Contributor guide

No contributing guide indexed for this repository

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 with the linked Passthrough Copy documentation page, especially its opening four paragraphs and the section discussing addPassthroughCopy and template extensions. Done means the language is clearer and the recommended best practice is stated explicitly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.