Suggestion for pagination/"before" documentation: clarify that only js front matter is supported
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Open src/docs/pagination.md at the linked lines and read the documentation for the “before” pagination callback alongside its front matter examples. Clarify that the value is a literal JavaScript function supported only with js front matter, then verify the wording remains consistent with the surrounding examples.
Written by the indexing model from the issue text.
Description
In the documentation for the "before" callback for pagination, it might be worth making explicit that this will only work for "js" front matter:
It may not be obvious to a reader that the "before" value of the front-matter here is a literal javascript function (rather than, say, a string that gets evaluated as javascript), and that therefore no other front-matter format besides "js" will work. (At least, I assume such is the case, from experimenting a little.)
It's true that a reader can perhaps infer this from the fact that the other examples on the page don't use js and this one does, or work it out with some trial and error: but people often read documentation in a hurry, so I think it's worth making this explicit.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from 11ty/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100