Repository navigation
fix: broken redirect links in developer-docs/contributing - #3343
Conversation
|
@naineel1209 is attempting to deploy a commit to the formbricks Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for following the naming conventions for pull request titles! 🙏 |
WalkthroughThe pull request introduces updates to the Formbricks documentation, specifically modifying the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- apps/docs/app/developer-docs/contributing/get-started/page.mdx (1 hunks)
- apps/docs/app/developer-docs/overview/page.mdx (1 hunks)
🧰 Additional context used
🔇 Additional comments (3)
apps/docs/app/developer-docs/overview/page.mdx (1)
Line range hint
1-36: LGTM: Well-structured overview of Formbricks Developer DocumentationThe metadata and content provide a comprehensive overview of the Formbricks Developer Documentation. The structure is clear, and the descriptions of various SDKs and APIs are informative and consistent.
Also applies to: 38-41
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: You might be missing the article “the” here.
Context: ...ur applications using our UI as well as API. Stay updated with real-time data and t...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
apps/docs/app/developer-docs/contributing/get-started/page.mdx (2)
Line range hint
3-7: LGTM: Metadata updates improve clarity and engagement.The changes to the metadata object enhance the documentation's discoverability and provide a clearer overview of the contribution process. The new title is more descriptive and engaging, while the updated description offers a concise summary of how to contribute to Formbricks.
🧰 Tools
🪛 LanguageTool
[formatting] ~41-~41: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...elopers we suggest using either of these, because you can dive into coding within minutes...(COMMA_BEFORE_BECAUSE)
37-38: URL updates look good. Verify redirects are working as expected.The changes to the Gitpod and GitHub Codespaces URLs align with the PR objectives to fix broken redirect links. The removal of the
/docsprefix should resolve the 404 errors mentioned in the issue.To ensure the changes are effective, please run the following script to check if the new URLs are accessible and don't result in 404 errors:
This script will help verify that the new URLs are working correctly in the development environment.
| Learn about Formbricks Webhooks and how to set up event-driven notifications in your applications using our UI as well as API. Stay updated with real-time data and trigger actions based on specific response events within your Formbricks environment. | ||
|
|
||
| ### [Contributing to Formbricks](/developer-docs/contributing) | ||
| ### [Contributing to Formbricks](/developer-docs/contributing/get-started) |
There was a problem hiding this comment.
💡 Codebase verification
Issues Found: Remaining Instances of Old Link
Several files still contain the old link /developer-docs/contributing that should be updated to /developer-docs/contributing/get-started:
README.mdCONTRIBUTING.md(line 1 for "Fork the Repository")apps/docs/next.config.mjsapps/docs/lib/navigation.ts(multiple entries)
Please update these instances to ensure all redirects function correctly.
🔗 Analysis chain
Approved: Link updated to fix broken redirect
The change from /developer-docs/contributing to /developer-docs/contributing/get-started addresses the PR objective of fixing the broken redirect. This update provides a more specific entry point for contributors.
To ensure consistency across the documentation, let's verify if this new link is used elsewhere:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for any remaining instances of the old link and confirm the existence of the new link target.
# Test 1: Search for any remaining instances of the old link
echo "Searching for any remaining instances of '/developer-docs/contributing':"
rg --type mdx '/developer-docs/contributing(?!/get-started)'
# Test 2: Confirm the existence of the new link target
echo "Checking for the existence of the new 'get-started' page:"
fd -e mdx 'page.mdx' apps/docs/app/developer-docs/contributing/get-started
Length of output: 768
Script:
#!/bin/bash
# Description: Find any instances of '/developer-docs/contributing' not pointing to '/developer-docs/contributing/get-started'
# Search for all instances of '/developer-docs/contributing'
echo "Searching for all instances of '/developer-docs/contributing':"
rg --type mdx '/developer-docs/contributing'
# Exclude the correct '/get-started' links
echo "Filtering out correct '/get-started' links:"
rg --type mdx '/developer-docs/contributing' | grep -v '/developer-docs/contributing/get-started'
Length of output: 440
Script:
#!/bin/bash
# Description: Find any instances of '/developer-docs/contributing' not pointing to '/developer-docs/contributing/get-started'
# Search for all instances of '/developer-docs/contributing' in any file type
echo "Searching for all instances of '/developer-docs/contributing':"
rg '/developer-docs/contributing'
# Exclude the correct '/get-started' links
echo "Filtering out correct '/get-started' links:"
rg '/developer-docs/contributing' | grep -v '/developer-docs/contributing/get-started'
Length of output: 2681
mattinannt
left a comment
mattinannt
left a comment
There was a problem hiding this comment.
@naineel1209 thank you very much for the link fixes :-)
|
Awarding naineel1209: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/naineel1209 |
Fixes #3344
What does this PR do?
This PR addresses the following broken routes on the Developer Docs page:
On the page Overview: fixes the broken redirect from
/developer-docs/contributingto/developer-docs/contributing/get-started.On the page Contributing - Get Started: fixes the broken redirects for Gitpod (from
/docs/developer-docs/contributing/gitpodto/developer-docs/contributing/gitpod) and for GitHub Codespaces (from/docs/developer-docs/contributing/codespacesto/developer-docs/contributing/codespaces).The broken URLs in [2] were caused by the
basePathalready being set to/docs, which caused the redirect links to include/docsredundantly, leading to errors.Checklist
Required
pnpm buildconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
New Features
Documentation