SSD-821: contact us template#346
Conversation
Feature: Template for contact us page (SOF-101)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
There was a problem hiding this comment.
Pull request overview
This PR adds a new "Contact Us" template to the MYDS documentation, providing developers with a ready-to-use UI component for contact pages. The changes also include translation updates to the login and forgot password documentation files, and adds a pull request template to standardize PR submissions.
Changes:
- Added a new ContactUsTemplate component with responsive layout, Google Maps integration, and social media links
- Created comprehensive English and Malay documentation for the contact us template
- Updated Malay translations in login and forgot password documentation for consistency
- Added a standardized pull request template
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| apps/docs/templates/contact-us.tsx | New React component providing a contact us page template with office information, map embed, and social links |
| apps/docs/content/docs/develop/(template)/contact-us.mdx | English documentation for the contact us template with usage examples and customization guide |
| apps/docs/content/docs/develop/(template)/contact-us.ms.mdx | Malay translation of contact us template documentation |
| apps/docs/content/docs/develop/(template)/login.ms.mdx | Translation update: "Login" → "Log Masuk" for title consistency |
| apps/docs/content/docs/develop/(template)/forgot-password.ms.mdx | Translation updates for consistency: "terlupa kata laluan" → "lupa kata laluan" |
| .github/pull_request_template.md | Added standardized PR template with checklist for contributors |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| TiktokIcon, | ||
| } from "@govtechmy/myds-react/icon"; | ||
|
|
||
| export default function ContactUsTemplate() { |
There was a problem hiding this comment.
The ContactUsTemplate component doesn't accept a className prop, but it's being used with className in the MDX documentation files (line 32 in both contact-us.mdx and contact-us.ms.mdx). Similar templates like LoginTemplate accept a className parameter for consistent styling flexibility. Add className as an optional prop parameter and apply it to the root element.
|
|
||
| ## Ringkasan Umum | ||
|
|
||
| Komponen `ContactUsTemplate` menyediakan contoh UI untuk skrin lupa kata laluan menggunakan komponen [MYDS](https://github.com/govtechmy/myds) Ia merangkumi: |
There was a problem hiding this comment.
The description incorrectly states this is for "skrin lupa kata laluan" (forgot password screen). This should be "skrin hubungi kami" (contact us screen) to match the actual purpose of the ContactUsTemplate component.
| Komponen `ContactUsTemplate` menyediakan contoh UI untuk skrin lupa kata laluan menggunakan komponen [MYDS](https://github.com/govtechmy/myds) Ia merangkumi: | |
| Komponen `ContactUsTemplate` menyediakan contoh UI untuk skrin hubungi kami menggunakan komponen [MYDS](https://github.com/govtechmy/myds) Ia merangkumi: |
| > - Butiran hubungan yang berfungsi untuk bingkai peta Google, nombor telefon dan e-mel | ||
| > - Pautan media sosial yang berfungsi | ||
| > | ||
| > You are expected to implement such logic based on your own system needs. |
There was a problem hiding this comment.
This English text is mixed into a Malay documentation file. It should be translated to Malay for consistency. The expected translation would be: "Anda dijangka melaksanakan logik tersebut berdasarkan keperluan sistem anda sendiri."
| > You are expected to implement such logic based on your own system needs. | |
| > Anda dijangka melaksanakan logik tersebut berdasarkan keperluan sistem anda sendiri. |
| - Responsive contact details section with google map frame, telephone and email. | ||
| - Social media links with icons styled according to the MYDS design guidelines. | ||
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | ||
|
|
||
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | ||
|
|
||
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | ||
| > - Working contact details for google map frame, telephone and email |
There was a problem hiding this comment.
The phrase "google map" should be capitalized as "Google Map" to match proper noun capitalization standards, as it refers to the Google Maps product.
| - Responsive contact details section with google map frame, telephone and email. | |
| - Social media links with icons styled according to the MYDS design guidelines. | |
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | |
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | |
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | |
| > - Working contact details for google map frame, telephone and email | |
| - Responsive contact details section with Google Map frame, telephone and email. | |
| - Social media links with icons styled according to the MYDS design guidelines. | |
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | |
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | |
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | |
| > - Working contact details for Google Map frame, telephone and email |
|
|
||
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | ||
| > - Working contact details for google map frame, telephone and email | ||
| > - Working Social media links |
There was a problem hiding this comment.
The phrase "Social media" should be lowercase "social media" to match standard English capitalization conventions where it's not at the beginning of a sentence or in a title.
| > - Working Social media links | |
| > - Working social media links |
| ## Customization | ||
|
|
There was a problem hiding this comment.
Duplicate "Customization" heading in English appears on line 417 immediately followed by "Penyesuaian" (the Malay translation of Customization) on line 419. Remove the duplicate English heading to maintain consistency in this Malay documentation file.
| ## Customization |
| - Responsive contact details section with google map frame, telephone and email. | ||
| - Social media links with icons styled according to the MYDS design guidelines. | ||
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | ||
|
|
||
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | ||
|
|
||
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | ||
| > - Working contact details for google map frame, telephone and email |
There was a problem hiding this comment.
The phrase "google map" should be capitalized as "Google Map" to match proper noun capitalization standards, as it refers to the Google Maps product. This same issue appears multiple times in the documentation.
| - Responsive contact details section with google map frame, telephone and email. | |
| - Social media links with icons styled according to the MYDS design guidelines. | |
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | |
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | |
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | |
| > - Working contact details for google map frame, telephone and email | |
| - Responsive contact details section with Google Map frame, telephone and email. | |
| - Social media links with icons styled according to the MYDS design guidelines. | |
| - A mobile-friendly layout that adapts from stacked sections to a single row on large screens. | |
| This contact us page template is built for **rapid development** and **easy integration**. It is designed to help teams get started faster by providing a layout that adheres to the **MYDS design system**, eliminating the need to piece together individual components manually. | |
| > ⚠️ **Note**: This is a **design-only template**. It does **not** include any functional logic such as: | |
| > - Working contact details for Google Map frame, telephone and email |
|
|
||
| ## Customization | ||
|
|
||
| You can edit anything inside the code, its fully customizable! |
There was a problem hiding this comment.
The possessive "its" should be the contraction "it's" (meaning "it is"). The sentence means "it is fully customizable", so the contraction with an apostrophe is correct here.
| You can edit anything inside the code, its fully customizable! | |
| You can edit anything inside the code, it's fully customizable! |
| ## Ciri-ciri | ||
|
|
||
| - Susun atur responsif sepenuhnya dengan grid adaptif untuk skrin kecil hingga besar. | ||
|
|
There was a problem hiding this comment.
There's an extra blank list item (line 413) immediately after the first feature item and before the second feature item. This creates an empty bullet point in the rendered documentation. Remove this blank line to maintain proper list formatting.
Summarise the feature
Issue ticket # SSD-821
Description:
Type of change
Checklist