Replies: 2 comments 2 replies
-
How exactly could the style guide be used to "mark" something as a book? The only thing I can think of is wrapping a link to a book in a span with a predetermined class. But there would be no way to enforce that via markdownlint, even for a custom rule, because there would be no way to know what links are actually to whole books or other things (context-based rule) and no way to catch when a link that is to a book isn't written with the special syntax. So even if someone was to go through the whole curriculum and add spans to existing books, should any books be added for whatever reason, there's a very high chance it gets added without the right syntax and not caught by anyone because there it won't be lint-checkable. |
Beta Was this translation helpful? Give feedback.
-
Thanks for the suggestion @Kezy-d4, I've converted this to a discussion until we've settled on if it's something we want to do or not. This has been suggested a few times on chat, but we've never seen the real value in the effort of doing and maintaining it. What kind of use cases/situations do you think would justify this feature? - what problem would it solve for our learners? |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Checks
Feature Request: brief description of feature request
format, e.g.Feature Request: Add a dark mode to the website
Description of the Feature Request
Please refer to this Discord conversation for important context: https://discord.com/channels/505093832157691914/1355281283747676391
There are several full-length books recommended throughout the Odin curriculum, usually as an additional resource. Examples include 99 Bottles Of OOP and Think Like A Programmer.
In the website's footer, there exists collections of useful resources; I'm referring to the Installation Guides and Community Guides. Similar to these collections, it may be useful to add a collection of each major book recommended throughout the Odin curriculum and feature it in the website's footer. The books should be listed in the same order in which they appear in the curriculum. The list should also mention and link to the exact lesson where each particular book was featured.
Automating such a list via the Style Guide would alleviate the manual maintenance/syncing work required from the team.
While I think such a collection would be valuable and convenient, I can imagine a potential issue: it may distract from the main curriculum itself, as we want to encourage learners to take the curriculum in order and as structured.
This could be remedied by including a prominent disclaimer/note atop the list emphasizing that it is merely meant as a reference and is supplementary, and learners should avoid skipping ahead to a book they haven't naturally encountered yet in the curriculum.
Acceptance criteria
Additional Comments
No response
Beta Was this translation helpful? Give feedback.
All reactions