Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parts of only one lesson #304

Open
eric-burel opened this issue Sep 2, 2024 · 1 comment · May be fixed by #374
Open

Parts of only one lesson #304

eric-burel opened this issue Sep 2, 2024 · 1 comment · May be fixed by #374
Labels
enhancement New feature or request

Comments

@eric-burel
Copy link
Contributor

Is your feature request related to a problem?

I'd like to write intro/outro parts that may not need a 3-level subdivision between part, chapter and lesson.

Currently, I need multiple levels so my introduction page maybe /getting-started/intro/about", instead of just /getting-started`. The UX is not as smooth as it could when it comes to writing proper course introductions or conclusions.

Describe the solution you'd like.

Allow having 2-levels or 1-level hierarchy.

intro
|_ _files
|_ content.md
|_ meta.md
short-part
|_ chapter-1
|__ _files
|__ content.md

Describe alternatives you've considered.

This seems a little change but I understand how this can affect UX.

  • We could allow having content in parts and chapters ? Maybe have special "intro.md"/"ending.md" files ?
  • Or keep content only in type "lesson", but allow a lesson to live outside of a chapter or part ? In this approach, as a default, we write lessons in a tutorial. Optionally, we can move lessons to a chapter. And optionnaly, we can move chapters into parts.
  • We could instead craft independant Astro pages, and focus on linking them to specific courses via meta data? For instance adding an "outro: /some-page" field to the chapter definition or something alike. But seems convoluted, mixing the mental model of Astro and the mental model of Tutorialkit.

Additional context

The file packages/astro/src/default/utils/routes.ts seems to be responsible to route creation and could be tweaked quite easily. However such a change may have consequences on the mental model around parts/chapters/lessons in other places.

@Nemikolh
Copy link
Member

Nemikolh commented Sep 2, 2024

Thanks for opening this issue!

I agree with the general idea proposed here, although I would instead allow the tutorial meta to have lessons or chapters which would achieve the same thing but keep the existing logic for parts and chapters.

If we don't allow mixed hierarchies where a tutorial has both parts and chapters / lessons, then it should be pretty easy to add.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants