[PR #3709] [MERGED] Implement FAQ component and integrate it into the main page #4488

Closed
opened 2025-11-20 06:10:16 -05:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/3709
Author: @BramSuurdje
Created: 4/6/2025
Status: Merged
Merged: 4/6/2025
Merged by: @MickLesk

Base: mainHead: faq-section


📝 Commits (7)

  • 2ec55b2 Implement FAQ component and integrate it into the main page; update package-lock.json for development dependencies.
  • ac8d75b Adjust Footer component padding for improved layout consistency
  • 573ed0b Update FAQ section div to include an ID for improved accessibility and navigation
  • e9d796f Adjust ScriptAccordion max height for improved layout consistency
  • 61035a7 Remove default value from Accordion in FAQ component
  • 48904f1 Refactor FAQ items for clarity and consistency; update titles and content for improved user understanding.
  • d544a9a Refactor FAQ component to use index as key for Accordion items; remove IDs from FAQ_Items for simplified mapping.

📊 Changes

6 files changed (+177 additions, -103 deletions)

View changed files

📝 frontend/package-lock.json (+4 -2)
📝 frontend/src/app/page.tsx (+105 -99)
📝 frontend/src/app/scripts/_components/ScriptAccordion.tsx (+1 -1)
frontend/src/components/FAQ.tsx (+29 -0)
📝 frontend/src/components/Footer.tsx (+1 -1)
frontend/src/config/faqConfig.tsx (+37 -0)

📄 Description

✍️ Description

This pull request includes several changes to the frontend package, focusing on updating dependencies, improving the Page component, and adding a new FAQ section. The most important changes are summarized below:

Dependency Updates:

  • Modified frontend/package-lock.json to set the dev property to true for several dependencies, including types-react, types-react-dom, prettier, and typescript. [1] [2] [3] [4]

Component Enhancements:

  • Updated the Page component in frontend/src/app/page.tsx to include an FAQ section and refactored the layout for better readability. [1] [2] [3] [4] [5] [6]

New FAQ Section:

  • Added a new FAQ component in frontend/src/components/FAQ.tsx to display frequently asked questions using an accordion layout.
  • Created a configuration file frontend/src/config/faqConfig.tsx to store FAQ items.

Minor Adjustments:

  • Adjusted the max-h property in ScriptAccordion to improve the layout.
  • Modified the padding in the Footer component for better spacing.

Link: #

Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No breaking changes – Existing functionality remains intact.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

🔍 Code & Security Review (X in brackets)

  • Follows Code_Audit.md & CONTRIBUTING.md guidelines

📋 Additional Information (optional)

image

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/3709 **Author:** [@BramSuurdje](https://github.com/BramSuurdje) **Created:** 4/6/2025 **Status:** ✅ Merged **Merged:** 4/6/2025 **Merged by:** [@MickLesk](https://github.com/MickLesk) **Base:** `main` ← **Head:** `faq-section` --- ### 📝 Commits (7) - [`2ec55b2`](https://github.com/community-scripts/ProxmoxVE/commit/2ec55b2bbadb030a8e0269328b1c4a90275a017b) Implement FAQ component and integrate it into the main page; update package-lock.json for development dependencies. - [`ac8d75b`](https://github.com/community-scripts/ProxmoxVE/commit/ac8d75b9d278961ab24c7a420196b518ed61f225) Adjust Footer component padding for improved layout consistency - [`573ed0b`](https://github.com/community-scripts/ProxmoxVE/commit/573ed0b073d412a4dd065b055ff092c02ccd8bd2) Update FAQ section div to include an ID for improved accessibility and navigation - [`e9d796f`](https://github.com/community-scripts/ProxmoxVE/commit/e9d796f8ef58143d06b4b268ebf6409871138121) Adjust ScriptAccordion max height for improved layout consistency - [`61035a7`](https://github.com/community-scripts/ProxmoxVE/commit/61035a79f4182f392994fa6b20b4f507beb1dae5) Remove default value from Accordion in FAQ component - [`48904f1`](https://github.com/community-scripts/ProxmoxVE/commit/48904f19a2aeb5f4480d45538a6e07d8744310c7) Refactor FAQ items for clarity and consistency; update titles and content for improved user understanding. - [`d544a9a`](https://github.com/community-scripts/ProxmoxVE/commit/d544a9ad597bb27ba90f2845b1df13b97689c677) Refactor FAQ component to use index as key for Accordion items; remove IDs from FAQ_Items for simplified mapping. ### 📊 Changes **6 files changed** (+177 additions, -103 deletions) <details> <summary>View changed files</summary> 📝 `frontend/package-lock.json` (+4 -2) 📝 `frontend/src/app/page.tsx` (+105 -99) 📝 `frontend/src/app/scripts/_components/ScriptAccordion.tsx` (+1 -1) ➕ `frontend/src/components/FAQ.tsx` (+29 -0) 📝 `frontend/src/components/Footer.tsx` (+1 -1) ➕ `frontend/src/config/faqConfig.tsx` (+37 -0) </details> ### 📄 Description <!--🛑 New scripts must first be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) for testing. PRs for new scripts that skip this process will be closed. --> ## ✍️ Description This pull request includes several changes to the `frontend` package, focusing on updating dependencies, improving the `Page` component, and adding a new FAQ section. The most important changes are summarized below: ### Dependency Updates: * Modified `frontend/package-lock.json` to set the `dev` property to `true` for several dependencies, including `types-react`, `types-react-dom`, `prettier`, and `typescript`. [[1]](diffhunk://#diff-4a2d9aa3e849b134993936ca81b83fb139edd2b0218077ab0f403b8c4803c62aL3258-R3258) [[2]](diffhunk://#diff-4a2d9aa3e849b134993936ca81b83fb139edd2b0218077ab0f403b8c4803c62aL3268-R3268) [[3]](diffhunk://#diff-4a2d9aa3e849b134993936ca81b83fb139edd2b0218077ab0f403b8c4803c62aR7854) [[4]](diffhunk://#diff-4a2d9aa3e849b134993936ca81b83fb139edd2b0218077ab0f403b8c4803c62aR9545) ### Component Enhancements: * Updated the `Page` component in `frontend/src/app/page.tsx` to include an FAQ section and refactored the layout for better readability. [[1]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fR2) [[2]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fR38-R40) [[3]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fL73-R70) [[4]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fL96-R91) [[5]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fL110-R107) [[6]](diffhunk://#diff-bc32312b6e0185cbc840269d0632c2a90ed907d36aa7bd3f8baeb68b9ff9449fR126-R141) ### New FAQ Section: * Added a new `FAQ` component in `frontend/src/components/FAQ.tsx` to display frequently asked questions using an accordion layout. * Created a configuration file `frontend/src/config/faqConfig.tsx` to store FAQ items. ### Minor Adjustments: * Adjusted the `max-h` property in `ScriptAccordion` to improve the layout. * Modified the padding in the `Footer` component for better spacing. ## 🔗 Related PR / Issue Link: # ## ✅ Prerequisites (**X** in brackets) - [x] **Self-review completed** – Code follows project standards. - [x] **Tested thoroughly** – Changes work as expected. - [ ] **No breaking changes** – Existing functionality remains intact. - [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. --- ## 🛠️ Type of Change (**X** in brackets) - [x] 🐞 **Bug fix** – Resolves an issue without breaking functionality. - [x] ✨ **New feature** – Adds new, non-breaking functionality. - [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. - [ ] 🆕 **New script** – A fully functional and tested script or script set. - [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata. - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. - [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. --- ## 🔍 Code & Security Review (**X** in brackets) - [x] **Follows `Code_Audit.md` & `CONTRIBUTING.md` guidelines** ## 📋 Additional Information (optional) <!-- Add any extra context, screenshots, or references. --> <img width="1679" alt="image" src="https://github.com/user-attachments/assets/cf35bcce-7800-448b-86f4-d6be808f8de6" /> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 06:10:16 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#4488