Skip to content
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

feat: independent troubleshooting guide page #1591

Merged

Conversation

ShubhamPalriwala
Copy link
Contributor

What does this PR do?

We now have a standalone Troubleshooting Guide page where each topic is linkable hence sharable so that its easier to share across on Discord or GitHub.

We move the existing troubleshooting options from the in-app surveys quickstart here and also add a couple of topics as per our JS widget. These can be expanded in real time as and when we find in the community the common friction points.

Type of change

  • This change is a documentation update

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read How we Code at Formbricks
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand bits
  • Ran pnpm build
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues
  • First PR at Formbricks? Please sign the CLA! Without it we wont be able to merge it 🙏

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Formbricks Docs if changes were necessary

Copy link

vercel bot commented Nov 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Updated (UTC)
formbricks-cloud ⬜️ Ignored (Inspect) Nov 7, 2023 10:33am
formbricks-com ⬜️ Ignored (Inspect) Nov 7, 2023 10:33am

Copy link
Contributor

github-actions bot commented Nov 7, 2023

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

apps/formbricks-com/app/docs/getting-started/quickstart-in-app-survey/page.mdx

Instead of importing each image individually, you can use dynamic imports to make your code cleaner and more maintainable. This will be particularly useful if the number of images increases in the future.
Create Issue

    const images = [];
    for (let i = 1; i <= 8; i++) {
      images.push(import(`./${i}-in-app-survey-or-popup-survey-setup.webp`));
    }

Instead of repeating the className attribute in each Image component, you can define a constant and use it for all the images. This will make your code DRY (Don't Repeat Yourself) and easier to maintain.
Create Issue

    const imageClassName = "max-w-full rounded-lg sm:max-w-3xl";

    <Image
      src={I1}
      alt="Choose in app survey template"
      quality="100"
      className={imageClassName}
    />

Copy link
Member

@mattinannt mattinannt left a comment

Choose a reason for hiding this comment

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

looks great, thank you :-)

@mattinannt mattinannt added this pull request to the merge queue Nov 7, 2023
Merged via the queue into main with commit 10ab71b Nov 7, 2023
14 checks passed
@mattinannt mattinannt deleted the shubham/for-1351-update-formbricks-js-troubleshooting-guide branch November 7, 2023 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants