-
Notifications
You must be signed in to change notification settings - Fork 4
Create troubleshooting page #116
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding this troubleshooting section! I made some suggestions that you can look at.
One other thing I would add is that we might want to figure out a common template for these troubleshooting instructions, e.g. something similar to what I've used in the past with simple Symptom/Resolution sections.
One o
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
I restructured it in this format, but I was wondering if I should change the titles from Symptom/Resolution to something a bit different (e.g., Issue/Fix)? |
Yup, that should be fine. The intent behind this minimal template is to enable people to scan our troubleshooting quickly and just check if an issue or symptom matches what they're seeing, plus we want to make it as easy to identify the user response as possible. Eventually, we'll have a lot of these bits of troubleshooting content, so the easier we can make it on our users to parse stuff, the better. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR gives us the initial troubleshooting section we need, LGTM!
Internal Notes for Reviewers
Create a new troubleshooting page with the two topics in this Notion doc.
For now, the page is under the FAQ section in the docs site, but it might make sense to put it in the Developer Framework section.

Addresses this story.
External Release Notes
New troubleshooting guide for addressing technical issues with the Developer Framework.