feat: integrate PushFeedback to collect feedback about docs

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "files.eol": "\n",
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
     "[mdx]": {
         "files.trimTrailingWhitespace": false
     },

docusaurus.config.js

@@ -12,6 +12,7 @@ const customFields = {
     legacyRoutes: cfg.LEGACY_ROUTES,
     // FIXME: Open Graph Experimental Mode.
     isOGExperimental: process.env.OG_EXP,
+    pushFeedbackProjectId: "5i2vbxcpaz",
 };
 
 /** @type {Config} */

i18n/en/code.json

@@ -147,17 +147,61 @@
         "message": "https://forms.gle/nsYua6bMMG5iBB3v7",
         "description": "Feedback share form url"
     },
-    "features.feedback-doc.thanks": {
-        "message": "Thank you for letting us know!",
-        "description": "DocFeedback block=Thanks"
+    "features.feedback-doc.button-text": {
+        "message": "Feedback",
+        "description": "The text on a floating button to leave feedback about the docs"
     },
-    "features.feedback-doc.title": {
+    "features.feedback-doc.email-placeholder": {
+        "message": "Your email (optional)",
+        "description": "The placeholder for email input"
+    },
+    "features.feedback-doc.error-message": {
+        "message": "Something went wrong. Please try again later.",
+        "description": "The error message displayed when feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-error-403": {
+        "message": "The request URL does not match the one defined in PushFeedback for this project.",
+        "description": "The title of the modal displayed when feedback form submission fails with 403 error"
+    },
+    "features.feedback-doc.modal-title-error-404": {
+        "message": "We could not find the provided project id in PushFeedback.",
+        "description": "The title of the modal displayed when feedback form submission fails with 404 error"
+    },
+    "features.feedback-doc.message-placeholder": {
+        "message": "Comments",
+        "description": "The placeholder for message input"
+    },
+    "features.feedback-doc.modal-title": {
+        "message": "Share your feedback",
+        "description": "The title of the modal to leave feedback about the docs"
+    },
+    "features.feedback-doc.modal-title-error": {
+        "message": "Oops!",
+        "description": "The title of the modal displayed when feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-success": {
+        "message": "Thanks for your feedback!",
+        "description": "The title of the modal displayed when feedback form submission succeeds"
+    },
+    "features.feedback-doc.screenshot-button-text": {
+        "message": "Take a Screenshot",
+        "description": "The text on a button to take a screenshot"
+    },
+    "features.feedback-doc.screenshot-topbar-text": {
+        "message": "SELECT AN ELEMENT ON THE PAGE",
+        "description": "The text displayed in the top bar when selecting an element to take a screenshot"
+    },
+    "features.feedback-doc.send-button-text": {
+        "message": "Send",
+        "description": "The text on a button to send feedback"
+    },
+    "features.feedback-doc.rating-placeholder": {
         "message": "Was this page helpful?",
-        "description": "DocFeedback block=Title"
+        "description": "The placeholder for rating input"
     },
-    "features.feedback-doc.subtitle": {
-        "message": "Your feedback helps us improve the docs",
-        "description": "DocFeedback block=Subtitle"
+    "features.feedback-doc.rating-stars-placeholder": {
+        "message": "How would you rate this page",
+        "description": "The placeholder for rating stars input"
     },
     "features.hero.tagline": {
         "message": "Architectural methodology for frontend projects",

i18n/ru/code.json

@@ -159,6 +159,62 @@
         "message": "Ваш фидбек помогает нам улучшать документацию",
         "description": "DocFeedback block=Subtitle"
     },
+    "features.feedback-doc.button-text": {
+        "message": "Оставить отзыв",
+        "description": "The text on a floating button to leave feedback about the docs"
+    },
+    "features.feedback-doc.email-placeholder": {
+        "message": "Оставьте ваш e-mail (по желанию)",
+        "description": "The placeholder for email input"
+    },
+    "features.feedback-doc.error-message": {
+        "message": "Пожалуйста, попробуйте позже.",
+        "description": "The error message displayed when feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-error-403": {
+        "message": "URL запроса не совпадает с URL, указанным в PushFeedback для этого проекта.",
+        "description": "The title of the modal displayed when the feedback form submission fails with 403 error"
+    },
+    "features.feedback-doc.modal-title-error-404": {
+        "message": "Мы не смогли найти предоставленный идентификатор проекта в PushFeedback.",
+        "description": "The title of the modal displayed when the feedback form submission fails with 404 error"
+    },
+    "features.feedback-doc.message-placeholder": {
+        "message": "Напишите ваш отзыв здесь…",
+        "description": "The placeholder for message input"
+    },
+    "features.feedback-doc.modal-title": {
+        "message": "Поделитесь вашим мнением",
+        "description": "The title of the modal displayed when the feedback form is opened"
+    },
+    "features.feedback-doc.modal-title-error": {
+        "message": "Упс!",
+        "description": "The title of the modal displayed when the feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-success": {
+        "message": "Спасибо за ваш отзыв!",
+        "description": "The title of the modal displayed when the feedback form submission is successful"
+    },
+    "features.feedback-doc.rating-placeholder": {
+        "message": "Была ли эта страница полезной?",
+        "description": "The placeholder for rating input"
+    },
+    "features.feedback-doc.rating-stars-placeholder": {
+        "message": "Как бы вы оценили эту страницу",
+        "description": "The placeholder for rating stars input"
+    },
+    "features.feedback-doc.screenshot-button-text": {
+        "message": "Сделать скриншот",
+        "description": "The text on a button to take a screenshot"
+    },
+    "features.feedback-doc.screenshot-topbar-text": {
+        "message": "Выберите элемент на странице",
+        "description": "The text displayed in the top bar of the screenshot tool"
+    },
+    "features.feedback-doc.send-button-text": {
+        "message": "Отправить",
+        "description": "The text on a button to send feedback"
+    },
     "features.hero.tagline": {
         "message": "Архитектурная методология для фронтенд проектов",
         "description": "Architectural methodology for frontend projects"

i18n/uz/code.json

@@ -152,13 +152,69 @@
         "description": "DocFeedback block=Thanks"
     },
     "features.feedback-doc.title": {
-        "message": "Sahifa foydali boldimi?",
+        "message": "Sahifa foydali bo'ldimi?",
         "description": "DocFeedback block=Title"
     },
     "features.feedback-doc.subtitle": {
-        "message": "Sizning fikr-mulohazalaringiz hujjatlarni yaxshilashga yordam beradi",
+        "message": "Sizning fikringiz bizga dastur dokumentatsiyasini yaxshilashda yordam beradi",
         "description": "DocFeedback block=Subtitle"
     },
+    "features.feedback-doc.button-text": {
+        "message": "Fikr-mulohaza qoldirish",
+        "description": "The text on a floating button to leave feedback about the docs"
+    },
+    "features.feedback-doc.email-placeholder": {
+        "message": "Sizning e-mailingizni qoldiring (ixtiyoriy)",
+        "description": "The placeholder for email input"
+    },
+    "features.feedback-doc.error-message": {
+        "message": "Iltimos, keyinroq urinib ko'ring.",
+        "description": "The error message displayed when feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-error-403": {
+        "message": "URL so'rovi bu proyekt uchun PushFeedbackda ko'rsatilgan URL bilan mos kelmadi.",
+        "description": "The title of the modal displayed when the feedback form submission fails with 403 error"
+    },
+    "features.feedback-doc.modal-title-error-404": {
+        "message": "Biz PushFeedbackda berilgan proyekt identifikatorini topolmadik.",
+        "description": "The title of the modal displayed when the feedback form submission fails with 404 error"
+    },
+    "features.feedback-doc.message-placeholder": {
+        "message": "Fikringizni shu yerga yozing…",
+        "description": "The placeholder for message input"
+    },
+    "features.feedback-doc.modal-title": {
+        "message": "Fikringizni ulashing",
+        "description": "The title of the modal displayed when the feedback form is opened"
+    },
+    "features.feedback-doc.modal-title-error": {
+        "message": "Xatolik!",
+        "description": "The title of the modal displayed when the feedback form submission fails"
+    },
+    "features.feedback-doc.modal-title-success": {
+        "message": "Fikringiz uchun rahmat!",
+        "description": "The title of the modal displayed when the feedback form submission is successful"
+    },
+    "features.feedback-doc.rating-placeholder": {
+        "message": "Ushbu sahifa foydali bo'ldimi?",
+        "description": "The placeholder for rating input"
+    },
+    "features.feedback-doc.rating-stars-placeholder": {
+        "message": "Ushbu sahifani qanday baholay olasiz",
+        "description": "The placeholder for rating stars input"
+    },
+    "features.feedback-doc.screenshot-button-text": {
+        "message": "Ekran surati olish",
+        "description": "The text on a button to take a screenshot"
+    },
+    "features.feedback-doc.screenshot-topbar-text": {
+        "message": "Sahifadagi elementni tanlang",
+        "description": "The text displayed in the top bar of the screenshot tool"
+    },
+    "features.feedback-doc.send-button-text": {
+        "message": "Yuborish",
+        "description": "The text on a button to send feedback"
+    },
     "features.hero.tagline": {
         "message": "Front-end loyihalari uchun arxitektura metodologiyasi",
         "description": "Architectural methodology for frontend projects"

package.json

@@ -44,6 +44,8 @@
         "picocolors": "^1.0.0",
         "plugin-image-zoom": "^1.2.0",
         "prism-react-renderer": "^2.3.1",
+        "pushfeedback": "^0.1.40",
+        "pushfeedback-react": "^0.1.40",
         "react": "^18.3.1",
         "react-cookie-consent": "^8.0.1",
         "react-dom": "^18.3.1",
@@ -78,8 +80,8 @@
         "@types/node": "^20.12.8",
         "@types/react": "^18.3.1",
         "@types/react-dom": "^18.3.0",
-        "@typescript-eslint/eslint-plugin": "^6.18.1",
-        "@typescript-eslint/parser": "^6.18.1",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
+        "@typescript-eslint/parser": "^6.21.0",
         "all-contributors-cli": "^6.26.1",
         "docusaurus-plugin-sass": "^0.2.5",
         "eslint": "^7.32.0",
@@ -92,7 +94,7 @@
         "stylelint-config-recess-order": "^4.4.0",
         "stylelint-config-recommended": "^13.0.0",
         "stylelint-config-standard-scss": "^11.1.0",
-        "typescript": "^5.4.5"
+        "typescript": "^5.5.3"
     },
     "packageManager": "pnpm@9.4.0"
 }