Что происходит с docs.modx.pro?

Привет форум!

Хотя с момента релиза новой версии сайта документации о нем ничего не было написано, работа по его улучшению все равно ведется. И в этой заметке я собираюсь рассказать о ней.



Генерация мета-тегов Open Graph


Хотя идея и лежала на поверхности, она всё же пришла после запуска, за что спасибо @Николай Савин. Ничего особенного, они генерируются теперь при сборке перед деплоем. В будущем есть планы генерации og:image как на github.com.

Исправления и улучшения интерфейса


После запуска я получил обратную связь от пользователей, за которую я им благодарен, и с её помощью удалось выявить ряд недочётов, которые были затем исправлены.

Увеличение картинок


По настоятельным просьбам некоторых пользователей был добавлен GLightbox для более удобного просмотра изображений в документации.

Обновлены зависимости


Движок VitePress на котором и генерируется сайт документации, на момент запуска находился в стадии бета-версии (v1.0.0-beta.3). Сейчас у него уже 24-ый кандидат на релиз (v1.0.0-rc.24), и все это время поддерживалась актуальность зависимостей.

Содержимое


И про содержимое я не забываю. Появились документации нескольких новых компонентов, дополняются и исправляются существующие. На последних остановимся поподробнее.

С помощью инструмента cspell удалось исправить большое количество опечаток и вот вам несколько интересных цифр.



Рекордсменом в разнообразии среди слов с опечатками оказалось слово «плейсхолдер», вот список с вариантами:

  • плейсходелр
  • плейсходер
  • плейсхолдет
  • плейсходлер
  • плейслолдер
  • плейсхлолдер
Еще в словах оказалось прячутся буквы из других раскладок, и самым частым среди них является латинская буква “C”.

Опечатки в коде компонентов


Также удалось выявить некоторые опечатки которые, к сожалению, внедрились в код компонентов.

SendIt

Компонент SendIt и его класс, свойства объектов и название события visability. Здесь слово «visibility» (англ. видимость) заменяет «visability», видимо вероятность получения визы.

Ideas

Компонент Ideas и его поле vote_aganist. В данном случае, вместо слова «against» (англ. против) выступает какой-то aganist.

Заключение


Как видите, ничего не стоит на месте, несмотря на то что я очень занят на основной работе. Я стараюсь находить время и делать что-то для сообщества. Кстати, скоро будет анонс кое-чего интересного.

И последнее, во всей документации были найдены 2 опечатки в названиях стран: Россия и Украина.

Спасибо всем за внимание и мира надо головой.

docs.modx.pro
Репозиторий на GitHub
☕ Угостить чашкой кофе
Баха Волков
30 октября 2023, 10:44
modx.pro
899
+22

Комментарии: 3

Дима Касаткин
30 октября 2023, 22:41
+1
Спасибо, читается на одном дыхании) Все признаки хорошего поста, и кликбейтный заголовок, и картинки, и примеры, и даже легко-троллинговая опечатка в финале :) Зачётно получилось!
    W.H.I.T.E
    31 октября 2023, 03:25
    +2
    Баха очень хорошо пишет.
      Руслан Алеев
      02 ноября 2023, 09:02
      +3
      Крутой проект, без дураков! Вроде когда дока есть — не замечаешь, но когда ее нету… =)
      Спасибище!
        Авторизуйтесь или зарегистрируйтесь, чтобы оставлять комментарии.
        3