docs: Missing page descriptions.

[harshsbhat]

What does this PR do?

For better SEO it is required to have a description for every page. Some of the pages from the docs were missing according to the report sent by Johannes. This PR adds those descriptions for better SEO. It is done for the following links:

https://formbricks.com/docs/development/standards/qa/testing-methodology
https://formbricks.com/docs/development/standards/technical/framework-usage
https://formbricks.com/docs/overview/open-source
https://formbricks.com/docs/self-hosting/advanced/migration

It also changes the 404 link of https://formbricks.com/cdn-cgi/l/email-protection#1e7671727f5e78716c737c6c777d756d307d7173 to GitHub Discussions.

How should this be tested?

• Run the docs app
• Notice the changes I mentioned above

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

Summary by CodeRabbit

• Documentation
  • Added descriptive metadata across several guides for clearer overviews.
  • Updated document titles to better reflect the specific content of each guide.
  • Revised support instructions in migration content to direct users to GitHub Discussions.

[vercel]

@harshsbhat is attempting to deploy a commit to the formbricks Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

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

[coderabbitai]

Walkthrough

This pull request implements updates to the metadata across multiple documentation files. A new description field has been added to several documents, providing a brief overview of their content. Additionally, title fields have been modified to include quotation marks or to clarify the context, such as indicating self-hosted configurations or specifying topics like third-party integrations and survey guides. One document also updates a warning section to direct users to GitHub Discussions for support instead of an email contact. These changes aim to enhance the clarity and consistency of the documentation.

Suggested labels

enhancement, writing, good first issue, 🕹️ oss.gg, hacktoberfest

Suggested reviewers

• jobenjada

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56222ca and 28a0206.

📒 Files selected for processing (1)

• docs/self-hosting/advanced/migration.mdx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/self-hosting/advanced/migration.mdx

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Run E2E Tests / Run E2E Tests

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/self-hosting/advanced/migration.mdx (2)

2-3: Add Metadata Description for SEO Improvement

The addition of the description: "Formbrics Self-hosted version migration" field in the front matter is a positive change. It provides a clear summary of the document’s purpose and will help improve SEO.

---

176-177: Update Warning Section with Correct Support Link

The warning message now directs users to reach out on GitHub Discussions for a custom quote. This update aligns with the PR objectives by helping users find support more effectively.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39aa9f0 and 56222ca.

📒 Files selected for processing (9)

• docs/development/standards/qa/testing-methodology.mdx (1 hunks)
• docs/development/standards/technical/framework-usage.mdx (1 hunks)
• docs/overview/open-source.mdx (1 hunks)
• docs/self-hosting/advanced/migration.mdx (2 hunks)
• docs/self-hosting/configuration/auth-sso/saml-sso.mdx (1 hunks)
• docs/xm-and-surveys/core-features/integrations/overview.mdx (1 hunks)
• docs/xm-and-surveys/surveys/link-surveys/quickstart.mdx (1 hunks)
• docs/xm-and-surveys/surveys/website-app-surveys/framework-guides.mdx (1 hunks)
• docs/xm-and-surveys/surveys/website-app-surveys/quickstart.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Build Formbricks-web / Build Formbricks-web
• GitHub Check: Run E2E Tests / Run E2E Tests
• GitHub Check: Run Linters / Linters

🔇 Additional comments (8)

docs/overview/open-source.mdx (1)

2-3: SEO Metadata Field Added: The new description field clearly summarizes the document’s content and purpose, which should positively impact SEO and clarity for end users.

docs/development/standards/technical/framework-usage.mdx (1)

2-3: Enhanced Metadata Clarity: Adding the description field provides a concise overview of how Formbricks utilizes Next.js, Tailwind CSS, and Prisma ORM. This description aligns well with the overall documentation strategy and improves discoverability.

docs/self-hosting/configuration/auth-sso/saml-sso.mdx (1)

2-4: Clarified Title and Consistent Description: Updating the title to "SAML SSO - Self-hosted" helps differentiate this setup from other SAML documentation, enhancing clarity for users seeking self-hosted configuration guidance. The description succinctly explains the document’s purpose.

docs/xm-and-surveys/surveys/website-app-surveys/framework-guides.mdx (1)

2-3: Metadata Enrichment and Link Correction: Introducing the description field gives a clear overview of the page's content and improves SEO. Additionally, the link directing users to GitHub Discussion is correctly set, ensuring that any previously broken links are now fixed.

docs/development/standards/qa/testing-methodology.mdx (1)

2-3: Improved Metadata Standardization: Wrapping the title in quotes and adding a descriptive description field creates a uniform metadata format across documentation. This not only enhances SEO but also provides a concise summary for readers.

docs/xm-and-surveys/surveys/link-surveys/quickstart.mdx (1)

2-4: Enhance Title and Description

Changing the title to "Quickstart - Link Surveys" and adding a clear description improves clarity by specifying the focus of this guide. This is excellent for both user guidance and SEO.

docs/xm-and-surveys/core-features/integrations/overview.mdx (1)

2-4: Revise Title to Reflect Content Focus

Updating the title from "Overview" to "Third-party Integrations" and adding a descriptive meta tag helps set the reader’s expectations correctly and enhances the document’s discoverability via SEO.

docs/xm-and-surveys/surveys/website-app-surveys/quickstart.mdx (1)

2-4: Clarify Quickstart Document for Web & App Surveys

The new title "Quickstart - Web & App Surveys" coupled with a detailed description now clearly communicates the guide's purpose. This update makes it easier for users to differentiate between the various quickstart guides and boosts SEO.

[mattinannt]

@harshsbhat thanks for the PR. Please fix the small typo, then we are ready to merge this :-)