diff --git a/astro.config.mjs b/astro.config.mjs index 41139d5e..36c03b69 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -470,6 +470,23 @@ export default defineConfig({ }, ], }, + { + label: "Feedback", + items: [ + { + label: "Feedback", + link: "feedback/feedback-form", + }, + { + label: "Feedback form documentation", + link: "feedback/feedback-form-documentation", + }, + { + label: "Feedback storage and access instructions", + link: "feedback/feedback-storage-and-access-instructions", + }, + ], + }, ], }), ], diff --git a/public/feedbackform.html b/public/feedbackform.html new file mode 100644 index 00000000..8873d154 --- /dev/null +++ b/public/feedbackform.html @@ -0,0 +1,97 @@ + + + + + +Feedback Form + + + +
+

Feedback Page

+

We would love your feedback

+

Our goal is to make a platform that simplifies your workday. You’ve been using Thoth Tech Documentation Website for a while now, and we’d love to know what you think about it. We really appreciate your feedback!

+ +
+ + + + + +
+ +
+ + +
+ + + + +
+ + + +
+
+ + + diff --git a/public/submitsuccess.html b/public/submitsuccess.html new file mode 100644 index 00000000..90e069c5 --- /dev/null +++ b/public/submitsuccess.html @@ -0,0 +1,46 @@ + + + + + +Feedback Submitted + + + +
+

Feedback Submitted

+

We would love your feedback

+

Our goal is to make a platform that simplifies your workday. You’ve been using Thoth Tech Documentation Website for a while now, and we’d love to know what you think about it. We really appreciate your feedback!

+ +
+

Thanks for sharing your feedback with us

+

Your feedback has been submitted successfully.

+

Your input is valuable to us and will help us improve our services.

+
+
+ + diff --git a/src/content/docs/feedback/feedback form documentation.md b/src/content/docs/feedback/feedback form documentation.md new file mode 100644 index 00000000..adc2f16d --- /dev/null +++ b/src/content/docs/feedback/feedback form documentation.md @@ -0,0 +1,52 @@ +--- +title: Feedback Form Implementation Documentation +description: Documentation of the feedback form setup for future maintenance and enhancement. +--- + +## Feedback Form Implementation Documentation + +### Overview + +This document outlines the implementation and setup of the feedback form used on the Thoth Tech +Documentation Website. It is intended to assist future students and developers in understanding the +current system and to facilitate further development and maintenance. + +### Tools Used + +- **HTML/CSS** for structuring and styling the form. +- **JavaScript** for front-end logic. +- **Web3Forms** for handling form submissions without server-side code. +- **Node.js** and **Express** for server-side logic in case of future custom backend integration. + +### Form Setup and Design + +The feedback form is designed to be simple yet functional, enabling users to quickly provide their +feedback on the Thoth Tech Documentation Website. It includes fields for user identification, +feedback content, and ratings: + +- **Name**: Allows the user to enter their name. +- **Email**: Allows the user to enter their email for follow-ups. +- **Feedback Type**: Users can select whether they are submitting a general suggestion or specific + improvement ideas. +- **Rating**: Users can rate their experience using star ratings. +- **Comments**: A textarea for additional comments. + +### Integration with Web3Forms + +Web3Forms is used to manage form submissions. This service was selected for its simplicity and the +ability to handle form submissions without the need for additional backend code, making it ideal for +projects with limited server-side interaction: + +#### How to Configure Web3Forms + +1. **API Key**: An API key is required from Web3Forms, which is included in the form's hidden input + field to authenticate requests. +2. **Form Action**: The form's `action` attribute is set to the Web3Forms endpoint URL. +3. **Method**: POST method is used to send data to the Web3Forms service. + +```html +
+ + +
+``` diff --git a/src/content/docs/feedback/feedback form.md b/src/content/docs/feedback/feedback form.md new file mode 100644 index 00000000..08311432 --- /dev/null +++ b/src/content/docs/feedback/feedback form.md @@ -0,0 +1,40 @@ +--- +title: Feedback Form +description: a way to provide feedback +--- + +#### We Value Your Feedback + +Thank you for choosing to share your thoughts with us. Your feedback helps us improve and continue +providing the best experience possible. + +#### How to Provide Feedback + +You have several options for sending us your feedback. Please choose the one that suits you best: + +##### Option 1: Fill Out Our Online Form + +Please fill out our detailed feedback form available at [Our Feedback Form](/feedbackform.html). It +only take a few minutes! + +##### Option 2: Contact your team leader or senior students + +If you have specific feedback or concerns that require direct communication, please reach out to +your team leader or seniro students. This ensures that your feedback is addressed promptly and +personally. + +--- + +#### What Happens Next? + +After you submit your feedback: + +- **We Review It:** All feedback is reviewed by our team to understand your needs and requirements. +- **We Plan:** We plan improvements based on the feedback we receive from you and other users. +- **We Implement:** We try out best to implement changes and improvements continuously to enhance + your experience. + +Your input is incredibly valuable to us, and we appreciate the time you take to help us improve. If +you have any immediate concerns, please don't hesitate to contact our company operation team. + +Thank you for your contribution! diff --git a/src/content/docs/feedback/feedback storage and access instructions.md b/src/content/docs/feedback/feedback storage and access instructions.md new file mode 100644 index 00000000..13f72b6a --- /dev/null +++ b/src/content/docs/feedback/feedback storage and access instructions.md @@ -0,0 +1,31 @@ +--- +title: Feedback Storage and Access Instructions +description: Documentation of the feedback form setup for future maintenance and enhancement. +--- + +## Feedback Handling Documentation + +### Overview + +This document outlines how feedback submissions from our website are handled. The feedback is sent +to a dedicated email address and stored securely for review by authorized personnel. + +### Feedback Submission Process + +1. **Form Submission**: When users submit feedback through the feedback form on our website, the + data is sent directly to a specified email address. +2. **Email Storage**: The feedback is stored in the inbox of this email account for future reference + and review by the team. + +### Email Address Details + +The email address dedicated to receiving and storing feedback submissions is documented in our +Trello board. Access details are as follows: + +- **Trello Board**: Company Operation Board +- **List**: Company Website List + +```html +##Another place to look up the email address and password There is also a document in conpamy +operation channel which includes the email address and password. +```