-
Notifications
You must be signed in to change notification settings - Fork 605
docs: add Zoho integration setup guide (ext-357) #3748
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
Contributor
Author
Contributor
Author
|
Closing due to inactivity for more than 7 days. |
lordsarcastic
suggested changes
Mar 28, 2025
- Restore contribution notes - Change useful links format from table to list - Add Going further section with Card component Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
lordsarcastic
approved these changes
Mar 28, 2025
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
lordsarcastic
suggested changes
May 14, 2025
Contributor
|
@lordsarcastic, this might be a good time to also add documentation for the other Zoho alias providers in this PR. You can follow this approach. |
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
Co-Authored-By: khaliq@nango.dev <khaliq@nango.dev>
lordsarcastic
approved these changes
May 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Zoho Integration Documentation Improvements
This PR enhances the Zoho integration documentation with a comprehensive setup guide and standardized documentation across all Zoho alias providers.
Changes
/snippets/zoho-shared/zoho-shared-useful-links.mdx- Common useful links for all Zoho services/snippets/zoho-shared/zoho-shared-gotchas.mdx- Common API gotchas for all Zoho servicesReferences
Link to Devin run: https://app.devin.ai/sessions/94f14c04f0bf4a7bb75ab740686940de
Requested by: khaliq@nango.dev
Comprehensive Overhaul & Standardization of Zoho Integration Documentation
This PR delivers a significant rework and modernization of all Zoho-related integration documentation, introducing a unified and comprehensive OAuth setup guide, shared documentation snippets for useful links and API gotchas, and service-specific guides for each Zoho alias provider (e.g., CRM, Books, Invoice, People, etc.). All provider docs now follow a standardized, DRY (Don't Repeat Yourself) pattern: repetitive setup instructions and OAuth details are replaced with references to a shared main guide, while ensuring provider-specific scopes, nuances, and gotchas are correctly isolated and easily maintainable. Documentation consistency, accuracy—especially with regard to region and data center information—and future extensibility have been prioritized, making onboarding for end users and future contributors much clearer and more streamlined.
Key Changes:
• Added a detailed, modular
OAuthsetup guide inzoho.mdxcovering multi-region/datacenter support and general onboarding best practices.• Created and refactored all Zoho provider docs (Bigin, Books,
CRM, Desk, Inventory, Invoice, Mail, People) to use new shared content components foruseful linksand ```API`` gotchas. • StandardizedCommon Scopes` sections to list format and clarified which scopes/links/nuances are provider-specific.• Removed outdated, redundant, or confusing instructions (such as connection configuration snippets) in favor of references to centralized shared guides.
• Improved overall documentation style, sectioning, example freshness, and made future edits easier by promoting documentation modularity.
Affected Areas:
• docs-v2/integrations/all/zoho.mdx
• docs-v2/integrations/all/zoho-bigin.mdx
• docs-v2/integrations/all/zoho-books.mdx
• docs-v2/integrations/all/zoho-crm.mdx
• docs-v2/integrations/all/zoho-desk.mdx
• docs-v2/integrations/all/zoho-inventory.mdx
• docs-v2/integrations/all/zoho-invoice.mdx
• docs-v2/integrations/all/zoho-mail.mdx
• docs-v2/integrations/all/zoho-people.mdx
• docs-v2/snippets/zoho-shared/zoho-shared-useful-links.mdx
• docs-v2/snippets/zoho-shared/zoho-shared-gotchas.mdx
Potential Impact:
Functionality: No impact to code execution. Documentation accuracy and onboarding experience are dramatically improved; facilitates correct integration setup, reduces redundant support queries, and enables easier updates as Zoho evolves.
Performance: No impact (documentation-only changes).
Security: Documentation now explicitly calls out credential handling, regional endpoint selection, and OAuth scope risks, reducing the likelihood of misconfiguration and related security issues.
Scalability: Shared, DRY documentation structure simplifies onboarding of new Zoho providers and future-wide updates, improving maintainability and decreasing manual update overhead.
Review Focus:
• Correctness and completeness of the shared
OAuthsetup guide and its general applicability across all Zoho providers.• That provider docs preserve service-specific requirements, region/dc handling, and do not lose detail through deduplication.
• Proper use and functioning of shared snippet components (imports, Markdown rendering).
• Freshness of examples, links, and scope lists.
• Contributors should ensure deduplication did not inadvertently remove important edge-case instructions.
Testing Needed
• Manual walkthrough of the
OAuthsetup flow in each Zoho region/data center to ensure the new steps are complete and accurate.• Verification that shared
MDXsnippets render properly in all contexts and do not break individual provider pages.• Ensure all provider-specific info (scopes/gotchas) remains and is current post-refactor.
• Check for link rot and confirm examples/reference links are up-to-date.
Code Quality Assessment
docs-v2/integrations/all/zoho-inventory.mdx: Only Inventory-relevant info listed; shared gotchas/links.
docs-v2/integrations/all/zoho-mail.mdx: Uses shared pattern, mail-specific details clear.
docs-v2/integrations/all/zoho-bigin.mdx: Service-specific; shared content used effectively; only Bigin-specific scope/gotchas remain.
docs-v2/integrations/all/zoho-invoice.mdx: Follows new pattern; concise, correct, DRY.
docs-v2/integrations/all/zoho-desk.mdx: Effective modular doc update, keeps Desk-specific focus.
docs-v2/snippets/zoho-shared/zoho-shared-useful-links.mdx: Concise, comprehensive, maintainable.
docs-v2/snippets/zoho-shared/zoho-shared-gotchas.mdx: Neatly captures global API caveats; easily extendable.
docs-v2/integrations/all/zoho.mdx: Highly modular, clear sectioning, logical flow. Adheres to DRY, well-maintained.
docs-v2/integrations/all/zoho-books.mdx: Clean refactor, accurate region notes, current links/examples.
docs-v2/integrations/all/zoho-crm.mdx: Deduplicated, focused on CRM details, uses new shared structure.
docs-v2/integrations/all/zoho-people.mdx: Imports shared content; clarifies People-specific nuances.
Best Practices
Security:
• Highlights proper handling of
OAuthcredentials• Explains scope implications and risk
Maintainability:
• Extensive use of shared markdown snippets encourages future extensibility
• Promotes
DRYand modular structureDocumentation:
• Consistent formatting, explicit sectioning/headings
• Provider-specific vs. shared content separation
• Encourages contributions and notes how to improve
Possible Issues
• If shared snippets or central guides are inaccurate, errors can propagate to all provider docs at once.
• Documentation for niche or rare Zoho services could be inadvertently lost or oversimplified during refactoring.
• Ongoing maintenance is necessary to keep shared content synchronized with Zoho API/platform changes.
• Reviewers should confirm all previously present, provider-specific business rules around auth and regional behavior still exist and are correct.
This summary was automatically generated by @propel-code-bot