11ty / 11ty/docs

Directory structure unclear

Open
#150 0 comments 0 reactions 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

Could we do something with the directory structure?
I mean, Quicktips were moved to Tutorials, but don't show up as sub-directory in the URL there. Example

Plus, they could have a title other than „Eleventy”. (I was hunting for that example right now).

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 Tutorials and Quicktips pages linked in the issue, comparing their visible titles and generated URL paths. Clarify the desired directory and naming scheme, then update the documentation structure so Quicktips are discoverable under Tutorials while preserving or deliberately changing the example URL; verify the affected links and page titles.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.