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

Naming of repo #2

Open
pwright opened this issue Sep 1, 2024 · 1 comment
Open

Naming of repo #2

pwright opened this issue Sep 1, 2024 · 1 comment

Comments

@pwright
Copy link

pwright commented Sep 1, 2024

As I browse the repos, I keep getting confused between the tutors-reference-* repos.
In my mind, one of them might be renamed, and given that you might surprise folks with 'manual' ("What tutors is a tool to create manuals?"), this seemed the better candidate.

On the other hand, the 'reference course' is confusing as I'm not sure if it's meant to be 'the' course that acts as a reference with every possible option exercised, so maybe that could become the 'validation-course'

Naming things is hard, would another option be to combine them into a single course?

@edeleastar
Copy link
Contributor

Thanks @pwright - yes, the naming could do with some reconsideration; We have the following:

  • tutors: the core ‘reader’ application
  • tutors-apps: the generator(s) + some cloud functions
  • tutors-reference-manual: the main documentation
  • tutors-reference-course: a test of all tutors learning objects in various configurations (link target for the manual)
  • layout-reference-course: alternative layout, recently introduced to display more interesting course structures

The first 2 were in a single monorepo, but I factored them out as it was a bit confusing for people coming to the project afresh, mainly because of the multiple targets (node CLI, SvelteKit, cloud etc…).

The last three could certainly be renamed to something more salient - happy to take suggestions.

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

No branches or pull requests

2 participants