Added docs for Instagram standalone provider option #67
Conversation
|
@goldsteinrazvan is attempting to deploy a commit to the Listinai Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe documentation for connecting Instagram to Postiz has been updated. A new “Connection Options” section has been introduced that details two methods: one via a Facebook Business account and one through an Instagram Standalone flow. The “Setting up Meta Application” section has been expanded with additional steps, and the step numbering has been adjusted to reflect the newly added and restructured sections. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant D as Documentation
participant FB as Facebook API
U->>D: Select Facebook Business Option
D->>FB: Initiate Login for Business Flow
FB-->>D: Return verification details
D->>U: Display instructions for Copy App ID and Secret
sequenceDiagram
participant U as User
participant D as Documentation
participant IG as Instagram API
U->>D: Select Instagram Standalone Option
D->>U: Display Professional Account Warning & Setup Instructions
U->>IG: Complete Dedicated Instagram Flow
IG-->>D: Provide Instagram App details
D->>U: Display instructions for Copy App ID and Secret
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:
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: 0
🧹 Nitpick comments (4)
pages/providers/instagram.mdx (4)
13-14: New "Connection Options" Section Added.
The new section clearly introduces the two methods for connecting an Instagram account. Consider using a bulleted list if additional options are introduced in the future to enhance readability.
55-56: Added "Set up Redirect URI" Step in Facebook Business Option.
This step clarifies how to configure the redirect URI for the business flow. If possible, consider linking to more detailed resources on configuring redirect URIs to aid less-experienced users.
87-88: Introduced "Instagram Standalone Option" Section.
The section clearly differentiates the standalone flow from the Facebook Business option. It might be beneficial to also mention that this option requires a professional Instagram account right at the beginning as a prerequisite.
95-98: "Set up Instagram" Step in Standalone Option.
This step is succinct; however, consider including additional details or links to further guidance if users are unfamiliar with the Instagram setup process to improve clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
public/images/providers/instagram-standalone/instagram-standalone-001.pngis excluded by!**/*.pngpublic/images/providers/instagram-standalone/instagram-standalone-002.pngis excluded by!**/*.pngpublic/images/providers/instagram-standalone/instagram-standalone-003.pngis excluded by!**/*.pngpublic/images/providers/instagram-standalone/instagram-standalone-004.pngis excluded by!**/*.png
📒 Files selected for processing (1)
pages/providers/instagram.mdx(4 hunks)
🔇 Additional comments (9)
pages/providers/instagram.mdx (9)
16-18: "Setting up Meta Application" Section Introduction.
The text provides a concise overview of the steps to set up a Meta application for Instagram. Ensure that the language and heading levels remain consistent with other documentation pages.
45-49: "Facebook Business Option" Section Addition.
This new section effectively outlines the process for users with a Facebook Business page. Verify that the transition from the previous section is smooth and that the introductory text aligns with the overall documentation style.
61-61: Added "Set up permissions" Step.
The header clearly introduces the permissions configuration process. For future iterations, you might want to expand on which permissions are critical or provide context on why each permission is needed.
73-77: New "Copy App ID and Secret" Step Updated.
The instructions, along with the visual aid, guide users through retrieving their credentials. Consider adding a brief note that indicates where to find these credentials within the Meta dashboard.🧰 Tools
🪛 LanguageTool
[uncategorized] ~76-~76: Possible missing comma found.
Context: ...51-47f8-8344-7fbc9de942e4) Go to basic permissions copy your App ID and App Secret and pas...(AI_HYDRA_LEO_MISSING_COMMA)
91-93: Warning Callout for Instagram Standalone Option.
The callout effectively warns users about the professional account requirement for the standalone option. The formatting is clear and draws attention to this important detail.
101-103: "Set up Instagram Business Login" Step Added.
The new step includes a clear visual and instructive text. Ensure that any prerequisites or settings required on Instagram’s side are mentioned elsewhere in the documentation if they apply.
106-109: "Set up Redirect URI" for Instagram Standalone Option.
Including the<OAuth2Redirect provider = "instagram-standalone" />component is consistent with similar flows. Double-check that the redirect URI instructions in this section match the actual configuration in the Postiz application.
111-119: Instructions for Copying Instagram App Credentials.
The step is detailed and includes a code snippet for setting environment variables. Verify that the variable names (e.g.,INSTAGRAM_APP_IDandINSTAGRAM_APP_SECRET) match what is expected by the application during runtime.
121-124: Final Step: Adding Instagram Standalone Channel in Postiz Application.
The instructions clearly describe how to add the Instagram standalone channel using the web interface. It would be helpful to periodically verify that these steps reflect the latest UI changes in the Postiz application.
Summary by CodeRabbit