webdoky / platform Goto Github PK

Один тиждень виглядає якось самотньо

Border - межа
Render - рендер
Progressbar - індикатор виконання
Iterables - ітеровані (об'єкти)
Assignment (operator) - (оператор) присвоєння

Наприклад: https://webdoky.org/uk/docs/Web/JavaScript/Reference/Global_Objects/String/Trim/

Зараз на продакшні це виглядає так, хоча ми достеменно знаємо, що якраз цю сторінку ми перекладали.

Наявна інформація про статус перекладу виглядає гарно, проте вона не дуже допомагає вибрати, яку сторінку перекласти наступною. Особливо це актуально зараз, коли фронт роботи дуже великий.
Потрібно якимось чином інтегруватись з рейтингом частоти відвідування сторінок MDN (який колись мав вигляд файлу popularities.json в репозиторії з проектом), і підтягнути цю інформацію у візуалізацію

Щоб і ми бачили, наскільки ми добре справляємося, і щоб відвідувачі могли самі оцінити актуальність контенту, та, можливо, допомогти нам із цим)

Колишня версія статистики на мдн, яку свого чаксу безжально випілили із проекту https://web.archive.org/web/20200926183452/https://developer.mozilla.org/uk/docs/MDN/Doc_status/JavaScript

У нас зараз є власні порти макросів kuma, які багато в чому засновані на коді https://github.com/mdn/yari. Нюанс полягає в тому, що сам Yari розповсюджується на умовах Mozilla Public License, а ми свій (похідний від оригінальних Kuma-макросів) код надаємо під МІТ-ліцензією. Це не критично, але бажано винести це в окремий пакунок, і ліцензувати його правильно

https://remixicon.com/ виглядає привабливо, + покриває більше потреб (зокрема дозволяє зробити аналог позначки "екпериментальний" в довіднику)

Наразі історія така, що ми повинні генерувати багато коду, якому не місце в логіці платформи. Навігація за розділами - це радше частина контенту, а не вебсайту, і поточна реалізація структури навігації в компонентах вебсайту виглядає трохи страшно. Підозрюю, це також змушує нас пересилати багато зайвого джаваскрипта по мережі. Бажано винести це повністю в порти макросів

Поточна реалізація індексує лише заголовки, що інколи призводить до ситуацій, коли певний термін доступний лише українською. Це виглядає як щось, що можна легко виправити, додавши пошук і за шляхом до сторінки

Резон webdoky/content#50

To reproduce:

• open the page (reload if necessary)
• click on the logo to navigate to the home
• see the exception in the console

Є принаймні один запит на таку абстракцію mdn/translated-content#1321. Є сенс зробити таку версію, англійською, щоб вона потихеньку йшла в маси.

Опис покращень тут webdoky/content#25

Що бажано мати:

1. Можливість переглянути сирці сторінки
2. Можливість почати редагувати сторінку в середовищі гітхабу
3. Можливість зарепортити проблему напряму в наші issue
   

Помилки будуть, і їх буде багато. Хотілося б мати можливість відслідковувати хоча б такі проблеми:

• невірна локалізація в посиланні
• зламане посилання (з інших причин)
• неправильний якір

Отже, план такий:

• Налаштувати PurgeCSS, щоб чистив наш Tailwind
• Переглянути і можливо почистити зайвий JavaScript
• Деякі сторінки створюють забагато DOM-вузлів, можливо це можна оптимізувати?

Початок історії виглядав так:

Раніше на цій сторінці була навігація, проте після останнього рефакторингу вона пропала

Наявний fuse.js уже дає 5Мб пошукового індексу, і далі буде тільки більше. Ми абсолютно точно не хочемо заставляти користувачів завантажувати десятки чи сотні мегабайт індексу

Запропоноване рішення: https://docsearch.algolia.com/docs/faq

Резон: webdoky/content#29

Щоб не реалізовувати одну й ту саму логіку двічі там, де цього можна легко уникнути. Наприклад - кастомний синтаксис для DefinitionList-елемента
https://github.com/mdn/yari/blob/main/markdown/m2h/handlers/dl.js