-
Notifications
You must be signed in to change notification settings - Fork 53
Instagram, Facebook, Threads, Pinterest, YouTube docs updates #125
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
Updated screenshots and swapped around some steps to their current order
Add correct business steps
Update screenshots and steps
Add App Roles instructions
@candidexmedia is attempting to deploy a commit to the Listinai Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThis update revises provider integration documentation for Facebook, Instagram, Threads, Pinterest, and YouTube. The changes clarify instructions, update screenshots, restructure steps for better guidance, and add new sections where necessary, such as app role assignment for Instagram and updated app creation flows for Threads and Facebook. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant MetaDevPortal
participant MetaBusinessSuite
participant Instagram
participant Pinterest
participant YouTube
User->>Documentation: Reads updated provider setup instructions
alt Facebook/Instagram
User->>MetaDevPortal: Selects business portfolio, creates app
User->>MetaDevPortal: Adds app details, configures roles (Instagram)
MetaDevPortal->>User: Provides app credentials/screens
end
alt Threads
User->>MetaBusinessSuite: Navigates to Settings > Apps
MetaBusinessSuite->>MetaDevPortal: Redirects after app creation
MetaDevPortal->>User: Continues setup
end
alt Pinterest
User->>Documentation: Views embedded images for App ID/Secret, Redirect URI
end
alt YouTube
User->>YouTube: Follows reorganized setup flow, enables APIs, configures consent screen
end
Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/providers/instagram.mdx (2)
14-14
: Fix typo: “Developpers” → “Developers”
Spelling mistake in the link text for Meta developer account.Apply:
- Both methods will require a [Meta for Developpers account](https://developers.facebook.com/apps/). + Both methods will require a [Meta for Developers account](https://developers.facebook.com/apps/).
126-155
: Review new “Adding App Roles” section for clarity & accessibility
- Correct spelling in image alt texts (“developpers” → “developers”).
- Ensure each screenshot has a descriptive alt text.
- Consider linking to the official Meta documentation for App Roles management.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/providers/facebook.mdx
(1 hunks)pages/providers/instagram.mdx
(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (4)
pages/providers/facebook.mdx (2)
15-16
: Step 1 instruction update looks good.
Clarity improved by emphasizing business portfolio selection first.
32-32
: New Step 4 addition aligns with updated process.
The step now clearly instructs users to fill details and click “Create App.”pages/providers/instagram.mdx (2)
22-23
: Align terminology with Facebook guide
The Step 1 text uses “Meta for developers,” whereas the Facebook docs reference “Facebook developers.” Consider standardizing wording across both guides for consistency.
39-42
: Confirm Step 4 consistency
A new Step 4 was introduced; please verify that the sequence and any downstream references (e.g., in TOC or cross-links) reflect this updated numbering.
Adding instructions which may address gitroomhq#124
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.
Please upload the images to the correct GitHub path, not Imgur.
Embed photos
Upload images for YouTube
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/providers/youtube.mdx (1)
32-33
: Nitpick: Refine heading phrasing
Consider using "Fill out OAuth details" or "Enter OAuth details" for more natural English.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing preposition found.
Context: ... configured. ### Fill in OAuth Details Create the OAuth client ID. Select "Web applic...(AI_HYDRA_LEO_MISSING_TO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
public/images/providers/youtube/Enable-APIs-and-Services.png
is excluded by!**/*.png
public/images/providers/youtube/YouTube-Add-Test-Users.png
is excluded by!**/*.png
public/images/providers/youtube/YouTube-Enabled-APIs.png
is excluded by!**/*.png
📒 Files selected for processing (1)
pages/providers/youtube.mdx
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/providers/youtube.mdx
[uncategorized] ~32-~32: Possible missing preposition found.
Context: ... configured. ### Fill in OAuth Details Create the OAuth client ID. Select "Web applic...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~64-~64: Possible missing comma found.
Context: ...BRAND ACCOUNTS Note: When using a Brand account you will need to set your APP to Extern...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~66-~66: Did you mean “Google Workspace”?
Context: ...the app to the trusted apps within your google workspace Admin. ### Go to admin.google.com Sig...
(GOOGLE_PRODUCTS)
[uncategorized] ~72-~72: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Controls --> API Controls Click Manage Third Party App Access ### Click "Configure new Ap...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...ur Client ID for the app you created in previous steps into the search box and select yo...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (9)
pages/providers/youtube.mdx (9)
18-21
: Good restructuring: Introduced a clear "General Setup" section
The new high-level heading and subheading organize the initial setup steps more effectively than numbered steps.
23-24
: Clear step: "Create Project" section
This subheading and description succinctly guide users through project creation.
26-27
: Clear step: "Create OAuth Credentials" section
The instructions under this heading are concise and actionable.
29-30
: Clear step: "Configure Consent Screen" section
This subheading clearly isolates consent screen configuration.
48-50
: Useful addition: "Add Test User" section
Highlighting this as a distinct step will help troubleshoot connection issues more quickly.
54-55
: Comprehensive detail: "Activate YouTube's API"
The expanded instructions and screenshots for enabling each API improve user guidance.
68-69
: Clear instruction: "Go to admin.google.com"
Directing users explicitly to the Admin console reduces ambiguity.
77-78
: Precise subheading: "Set scopes and Google Data Access to Trusted"
This clarifies trust configuration in Google Admin.
80-80
: Helpful timing note: Wait at least 5 hours
Including propagation time is crucial for setting expectations.
Add local images
IG images
Add local images 😪
image for threads
Add local image
@ennogelhaus Should be fixed |
Add troubleshooting
Clean up some phrases
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/providers/threads.mdx (2)
18-18
: Clarify the navigation step for app naming
The guide jumps directly to naming the app without indicating where to initiate the "Create App" action. Consider adding a brief note like "click Create App" to orient users.
58-58
: Nit: Add missing commas for readability
The sentence is missing commas around the setup wizard clause. For example:- Go back to the 'Dashboard' view of the Facebook developers portal and click "Finish customization". Make sure you clicked through the setup wizard, and select "Yes I'm finished" to complete the setup. ... + Go back to the 'Dashboard' view of the Facebook developers portal and click "Finish customization". Make sure you clicked through the setup wizard, and select "Yes, I'm finished," to complete the setup. ...🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: Possible missing comma found.
Context: ...d through the setup wizard, and select "Yes I'm finished" to complete the setup. Th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ... done this. Ignore "Test use cases" for now as it will not work until you have crea...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/providers/threads.mdx
(4 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/providers/threads.mdx
[uncategorized] ~58-~58: Possible missing comma found.
Context: ...d through the setup wizard, and select "Yes I'm finished" to complete the setup. Th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ... done this. Ignore "Test use cases" for now as it will not work until you have crea...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (2)
pages/providers/threads.mdx (2)
32-32
: Great troubleshooting addition
This note on enabling 2FA when no business portfolios are available adds valuable guidance for users facing this issue.
75-76
: Verify the correct tab name and domain references
The instructions reference the Invitates tab on threads.com, but this label seems unfamiliar. Please confirm whether the tab is actually named "Invitations" or "Invites" and update the text and URL domain accordingly.
Fix typos and clarified a step based on Code Rabbit feebdack
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.
Actionable comments posted: 1
🧹 Nitpick comments (3)
pages/providers/threads.mdx (3)
10-10
: Fix grammar and unify portal naming
The phrase "have setup" should be "have set up" and use "Meta for Developers portal" for consistency with other docs.- This integration requires that you have setup a Meta for Developers account already. You can start by going to the [Meta/Facebook Developer Portal](https://developers.facebook.com/apps). + This integration requires that you have set up a Meta for Developers account already. You can start by going to the [Meta for Developers portal](https://developers.facebook.com/apps).
18-18
: Refine instruction wording for clarity
Consider specifying "the Meta for Developers portal" to mirror terminology in related docs.- Go to Meta for Developers and [create a new app](https://developers.facebook.com/apps/creation/). Give your app a name and email. + Go to the Meta for Developers portal and [create a new app](https://developers.facebook.com/apps/creation/). Give your app a name and email.
58-58
: Improve consistency and punctuation
Update portal naming and remove the comma before "and select" for smoother reading.- Go back to the 'Dashboard' view of the Facebook developers portal and click "Finish customization". Make sure you clicked through the setup wizard, and select "Yes I'm finished" to complete the setup. + Go back to the 'Dashboard' view of the Meta for Developers portal and click "Finish customization". Make sure you clicked through the setup wizard and select "Yes I'm finished" to complete the setup.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: Possible missing comma found.
Context: ...d through the setup wizard, and select "Yes I'm finished" to complete the setup. Th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ... done this. Ignore "Test use cases" for now as it will not work until you have crea...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/providers/threads.mdx
(4 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/providers/threads.mdx
[style] ~12-~12: Consider an alternative verb to strengthen your wording.
Context: ... take some time to get it right. If you have any issues, please reach out to us on t...
(IF_YOU_HAVE_THIS_PROBLEM)
[formatting] ~12-~12: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...This documentation is not fully complete, because at the time of writing the Threads API ...
(COMMA_BEFORE_BECAUSE)
[uncategorized] ~12-~12: Possible missing comma found.
Context: ... fully complete, because at the time of writing the Threads API seems like it's having ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ...d through the setup wizard, and select "Yes I'm finished" to complete the setup. Th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ... done this. Ignore "Test use cases" for now as it will not work until you have crea...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (1)
pages/providers/threads.mdx (1)
32-32
: Troubleshooting note added correctly
The guidance on enabling Two-Factor Authentication (2FA) in Meta Business Suite is clear and aligns with Instagram/Facebook docs.
Summary by CodeRabbit