Skip to content

feat(docs): docs migration iteration 3#5203

Open
khaliqgant wants to merge 1 commit intomasterfrom
docs-restructure-batch-three
Open

feat(docs): docs migration iteration 3#5203
khaliqgant wants to merge 1 commit intomasterfrom
docs-restructure-batch-three

Conversation

@khaliqgant
Copy link
Member

@khaliqgant khaliqgant commented Jan 7, 2026

Builds on #5056 and #5037

Migrates over

  • atlassian
  • greenhouse
  • servicenow
  • workday
  • monday
  • docusign
  • lever

Docs migration for seven integrations with updated navigation & provider metadata

This PR migrates the Atlassian, Greenhouse, ServiceNow, Workday, Monday, DocuSign, and Lever integration docs into the new IA structure, adding quickstart guides, setup instructions, and SCIM/connect specifics. It also aligns site navigation, redirects, and providers.yaml metadata to the new /api-integrations/... slug structure so in-product links resolve to the restructured pages.

Key Changes

• Added new docs/api-integrations/* guides (quickstart, setup, connect) for Atlassian, Greenhouse, ServiceNow, Workday, Monday, DocuSign, and Lever with updated frontmatter and embedded examples.
• Updated docs/docs.json navigation, sidebar entries, and redirects to point legacy /integrations/all/... slugs to the new /api-integrations/... locations.
• Refreshed packages/providers/providers.yaml for the affected providers so docs, setup_guide_url, and docs_connect fields reference the new documentation paths.

Affected Areas

• Documentation site content under docs/api-integrations
• Navigation/redirect configuration in docs/docs.json
• Provider metadata in packages/providers/providers.yaml


This summary was automatically generated by @propel-code-bot

@khaliqgant khaliqgant requested a review from rguldener January 7, 2026 10:41
@my-senior-dev-pr-review
Copy link

🤖 My Senior Dev — Analysis Complete

👤 For @khaliqgant

📁 Expert in docs (199 edits) • ⚡ 13th PR this month

View your contributor analytics →


📊 17 files reviewed • 4 need attention

🚨 High Risk:

  • docs/api-integrations/atlassian.mdx — Key documentation for user onboarding and clarity in integration steps.

⚠️ Needs Attention:

  • docs/docs.json — Changes to this JSON file help maintain the structure of documentation; affecting how users navigate.
  • packages/providers/providers.yaml — Modification of documentation URLs within this file ensures proper linking in the context of user onboarding, requiring confirmation that all links are accurate.

📚 Relevant Past Discussions:

  • ⚠️ Unresolved discussions on providers.yaml — 10 unresolved comments on this file from past PRs

🚀 Open Interactive Review →

The full interface unlocks features not available in GitHub:

  • 💬 AI Chat — Ask questions on any file, get context-aware answers
  • 🔍 Smart Hovers — See symbol definitions and usage without leaving the diff
  • 📚 Code Archeology — Understand how files evolved over time (/archeology)
  • 🎯 Learning Insights — See how this PR compares to similar changes

💬 Chat here: @my-senior-dev explain this change — or try @chaos-monkey @security-auditor @optimizer @skeptic @junior-dev

📖 View all 12 personas & slash commands

You can interact with me by mentioning @my-senior-dev in any comment:

In PR comments or on any line of code:

  • Ask questions about the code or PR
  • Request explanations of specific changes
  • Get suggestions for improvements

Slash commands:

  • /help — Show all available commands
  • /archeology — See the history and evolution of changed files
  • /profile — Performance analysis and suggestions
  • /expertise — Find who knows this code best
  • /personas — List all available AI personas

AI Personas (mention to get their perspective):

Persona Focus
@chaos-monkey 🐵 Edge cases & failure scenarios
@skeptic 🤨 Challenge assumptions
@optimizer Performance & efficiency
@security-auditor 🔒 Security vulnerabilities
@accessibility-advocate Inclusive design
@junior-dev 🌱 Simple explanations
@tech-debt-collector 💳 Code quality & shortcuts
@ux-champion 🎨 User experience
@devops-engineer 🚀 Deployment & scaling
@documentation-nazi 📚 Documentation gaps
@legacy-whisperer 🏛️ Working with existing code
@test-driven-purist Testing & TDD

For the best experience, view this PR on myseniordev.com — includes AI chat, file annotations, and interactive reviews.

</Step>
<Step title="Configure the redirect URL">
On the created app page, select the _Build_ dropdown at the right side of the page.
Select _OAuth and Permissions_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Add a period at the end of "Select OAuth and Permissions" to keep sentence punctuation consistent in this step.

Context for Agents
[**Documentation**]

Add a period at the end of "Select _OAuth and Permissions_" to keep sentence punctuation consistent in this step.

File: docs/api-integrations/monday/how-to-register-your-own-monday-api-oauth-app.mdx
Line: 25


## Important API Considerations

**Refresh token expiration:** Refresh tokens will expire after 365 days of non-use and will expire by 90 days if the resource owner is inactive for 90 days. Make sure you call `nango.getConnection()` at least every 365 days to trigger a refresh. See [Atlassian's OAuth documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#how-do-i-get-a-new-access-token--if-my-access-token-expires-or-is-revoked-) for more details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Fix grammar: change "will expire by 90 days" to "will expire after 90 days" (or similar) to accurately describe the 90-day inactivity expiration.

Context for Agents
[**Documentation**]

Fix grammar: change "will expire by 90 days" to "will expire after 90 days" (or similar) to accurately describe the 90-day inactivity expiration.

File: docs/api-integrations/atlassian/how-to-register-your-own-atlassian-api-oauth-app.mdx
Line: 58

<img src="/integrations/all/workday/credentials.png" />
4. Confirm the ISU account has been created by viewing **All Workday Accounts** and filter on the **Username** you created.
<img src="/integrations/all/workday/confirm_user.png" />
5.Go to the search bar and type **Create Security Group** then select it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Insert a space after "5." so the ordered list renders correctly.

Context for Agents
[**Documentation**]

Insert a space after "5." so the ordered list renders correctly.

File: docs/api-integrations/workday/connect.mdx
Line: 41

<img src="/integrations/all/workday/view_isu_group.png" />
12. Add all of the required domain security policies with the proper view/modify access for the **Integration Permissions**.
<Tip>In Workday, all security changes remain **pending** until they are activated by a user with the appropriate permissions.</Tip>
13. Activate your security policy changes by;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Replace the semicolon after "Activate your security policy changes by" with a colon to introduce the following list properly.

Context for Agents
[**Documentation**]

Replace the semicolon after "Activate your security policy changes by" with a colon to introduce the following list properly.

File: docs/api-integrations/workday/connect.mdx
Line: 57

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the Stale label Feb 6, 2026
11. Navigate to **ellipses** > **Security Group** > **Maintain Domain Permissions for Security Group**.
<img src="/integrations/all/workday/view_isu_group.png" />
12. Add all of the required domain security policies with the proper view/modify access for the **Integration Permissions**.
<Tip>In Workday, all security changes remain **pending** until they are activated by a user with the appropriate permissions.</Tip>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Replace the typo by; with by: and indent the three hyphenated steps beneath it so they stay nested under Step 13 rather than starting a new top-level list.

Context for Agents
[**Documentation**]

Replace the typo `by;` with `by:` and indent the three hyphenated steps beneath it so they stay nested under Step 13 rather than starting a new top-level list.

File: docs/api-integrations/workday/connect.mdx
Line: 56

@github-actions github-actions bot removed the Stale label Feb 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant