Developer-DAO / academy-turbo

D_D Academy is an open-source education platform created by and for Developer DAO.
https://academy.developerdao.com
MIT License
16 stars 10 forks source link

Feature: seo meta data source of truth. lesson titles and descriptions #218

Open kempsterrrr opened 6 months ago

kempsterrrr commented 6 months ago

215 introduces several improvements to SEO. However, we still have the following problems:

  1. No unique descriptions are showing for individual lesson pages
  2. Duplicated data across DB and .mdx files
  3. There is no easy way to update and maintain this single source of truth (all currently hardcoded across multiple files)

@Markkos89 is working on an admin panel. I suggest also considering moving from local .mdx files to a headless CMS for content authoring in the mid-to-long term.

Opening this specific issue to close #214

Markkos89 commented 6 months ago

My tow cents here

I also proposed/asked this (CMS) a time ago, and the answer was that having the .mdx files publicly in the github repo helps with the building/reviewing process which is true. So I believe into keeping it this way.

regarding duplication of information, there is information that is there but is not being used. Maybe what we should do is a clean up. Most of the lesson's and track's information are coming from the database which is what we are keeping because the progress tracking works with the database.

Markkos89 commented 5 months ago
  • No unique descriptions are showing for individual lesson pages

@kempsterrrr mate, regarding this point I will have to disagree.. Can you check the database lessons table? We already have Lesson Descriptions (unique) stored in the db.

check screenshots for reference:

Lessons descriptions info **example** ![image](https://github.com/Developer-DAO/academy-turbo/assets/2791028/40875947-d176-4ebb-9921-5a069346eddb)
Tracks descriptions info **example** ![image](https://github.com/Developer-DAO/academy-turbo/assets/2791028/2794e7e0-54ea-4201-adcd-c51be89f6486)

Note: both screenshots refer to staging env so the info might NOT be precise

Duplicated data across DB and .mdx files

I would be much appreciated if you can point some examples of duplicated data @kempsterrrr :pray: most of the scenarios I can tell.. It's beacause the source of truth for the Layouts components (TracksLayout and LessonsLayout) is hardcoded text in each file.. Please notice this, IF there are duplicated data (client & DB) would be MAINLY because the I added the data to the DB so I can start handling it in that layer and IT'S NOT refactored to that source YET.

Let me know any good example you can point :pray: Thank you very much!