Skip to content

docs: reincorporate feedback and thumb ratings to documentation pages #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

mmcallister
Copy link
Contributor

@mmcallister mmcallister commented May 12, 2025

Setting up pushfeedback with the Docusaurus steps, suggested by Travis as an alternative to manually creating it (draft in #182)

The dashboard to look through the test feedback can be found here: https://app.pushfeedback.com/teleport/projects/467su2n7t9/

@mmcallister mmcallister self-assigned this May 12, 2025
@mmcallister mmcallister added the documentation Improvements or additions to documentation label May 12, 2025
Copy link

github-actions bot commented May 12, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
pushfeedback 18be593 6 ✅SUCCEED pushfeedback 2025-05-13 20:12:30

@mmcallister mmcallister requested a review from Copilot May 12, 2025 21:41
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reincorporates feedback and integrates push feedback via Docusaurus by adding the necessary dependency and plugin configuration. Key changes include:

  • Adding "docusaurus-pushfeedback" dependency to package.json.
  • Removing the "storybook" dependency from package.json.
  • Configuring the docusaurus-pushfeedback plugin with the designated project id in docusaurus.config.ts.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
package.json Adds pushfeedback dependency and removes the storybook entry.
docusaurus.config.ts Inserts the pushfeedback plugin configuration with a hardcoded project id.
Comments suppressed due to low confidence (1)

package.json:112

  • Ensure that the removal of the 'storybook' dependency is intentional and that no other parts of the project rely on it.
"storybook": "^8.6.12",

@@ -258,6 +258,11 @@ const config: Config = {
},
],
extendedPostcssConfigPlugin,
[
'docusaurus-pushfeedback',{
project: '467su2n7t9'
Copy link
Preview

Copilot AI May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using an environment variable for the project id to enhance flexibility and avoid hardcoding values in the configuration.

Suggested change
project: '467su2n7t9'
project: process.env.PUSHFEEDBACK_PROJECT_ID || '467su2n7t9'

Copilot uses AI. Check for mistakes.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@mmcallister mmcallister marked this pull request as draft May 13, 2025 18:42
@mmcallister mmcallister requested a review from Copilot May 13, 2025 18:42
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reincorporates feedback and integrates thumb ratings into the documentation pages by setting up pushfeedback with the Docusaurus steps.

  • Added the "@storybook/react" and "docusaurus-pushfeedback" dependencies while removing the legacy "storybook" dependency in package.json.
  • Configured the docusaurus-pushfeedback plugin with the specified project ID in docusaurus.config.ts.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
package.json Added dependencies for pushfeedback and updated Storybook dependencies by removing legacy "storybook".
docusaurus.config.ts Introduced a new plugin configuration for docusaurus-pushfeedback with project "467su2n7t9".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant