-
In the Learn docs, every "lesson page" has a section at the end titled "In this module", that lists all the lessons in this module: https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Build_your_own_function#in_this_module. This list is very hard to maintain, because every time a new lesson is added, removed, or even just reordered, we have to update this section in every page, and people always forget or make mistakes. Over in mdn/yari#7444 (comment), @hamishwillee suggested that now sidebars are less broken, perhaps we don't need this any more, and the same thing came up in mdn/yari#8014 (comment). So this discussion is to find out if there is consensus for this. |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments 3 replies
-
Yes please. To be very clear I think the module lists provide a clearer picture that the modules are a set of related and ordered topics than the sidebar. If it were possible/easy to generate them from the sidebar I'd be happy with that. But I don't think they are needed any more to provide general context of what comes before and next, and IMO they are certainly not worth the cost of maintenance. |
Beta Was this translation helpful? Give feedback.
-
I would add a |
Beta Was this translation helpful? Give feedback.
-
To provide a bit of context here, the only reason these were added is because Sheppy was doing some SEO research way back when, and one of the items that came up is that each page should have a clear TOC for the directory it is in, so you've got a clear navigation path across the directory, regardless of what level you are at. But I'm not sure how much advantage this brings in terms of SEO, and I doubt it outweighs the maintenance burden. So I would support this too, provided we make sure readers still have their prev and next links, so the learning pathway is not broken. |
Beta Was this translation helpful? Give feedback.
-
Sounds like there's consensus for this to go ahead - if we feel it's necessary to have an overview we should find a way to generate it and not author it 👍 |
Beta Was this translation helpful? Give feedback.
-
I've filed an issue to remove it -> mdn/content#24467 |
Beta Was this translation helpful? Give feedback.
I've filed an issue to remove it -> mdn/content#24467