Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<!-- The following rules are extracted from user-supplied rules files -->
<!-- Generated by cursor-rules-to-claude v1.0.0 -->

<!-- Auto attached rules -->

# Hub Documentation

This rule can be found [here](.cursor/rules/hub-documentation.md)

<rule>
name: hub_documentation
description: Standards for creating and maintaining hub documentation guides

filters:
- type: file_extension
pattern: "\\.mdx$"
- type: path
pattern: "^connection-guides/"

actions:
- type: validate
conditions:
- pattern: "^---\ntitle:.*\ndescription:.*\n---"
message: "Each guide must start with frontmatter containing title and description"
- pattern: "import IntegrationFooter.*"
message: "Must import and use IntegrationFooter component"
- pattern: "<Steps>.*</Steps>"
message: "Must use Steps component for integration instructions"

- type: suggest
message: |
Hub documentation guides must follow this structure:

1. File Location:
- Place directly in connection-guides/{category}/{integration-name}.mdx
- Use kebab-case for filenames
- Categories: ats, documents, hris, iam, lms, marketing, screening, crm
- IMPORTANT: Do NOT place in docs/hubs/{category}/ - place directly in the category folder

2. Required Frontmatter:
```mdx
---
title: "Integration Name"
description: "Follow these steps to connect {Integration} via the StackOne Hub successfully."
---
```

3. Required Imports:
```mdx
import IntegrationFooter from "/snippets/integration-footer.mdx"
```

4. Standard Sections:
- Warning (if applicable)
- Introduction paragraph
- Authentication steps in <Steps> component
- IntegrationFooter
- Available data section

5. Authentication Patterns:
- OAuth
- API Key
- Service Account
- Partner OAuth
Each pattern has specific required steps

6. Image Guidelines:
- Store in /images/{integration-name}/
- Use descriptive kebab-case names
- Include in <Frame> components
- Add alt text and className

7. **Link Validation Requirements:**
- Test ALL external links before adding them to documentation
- Verify links are accessible and return expected content
- Check that API documentation links are still valid
- Ensure provider website links are working
- Test any download links or resource links
- If a link is broken, either find an alternative or remove it
- Consider adding link checking to your documentation workflow

8. **Linking Section Guidelines:**
- Use generic language like "your platform" or "the integration platform" instead of "StackOne"
- Focus on the provider's perspective and what they need to do
- Avoid mentioning specific product names in the linking steps
- Example: "Navigate to the Integrations page in your platform" instead of "Navigate to StackOne Hub"

9. **Integration Index Entry:**
- After creating a new guide, add an entry in `integrations.mdx` that redirects or links to the new guide.
- Example:
```mdx
- name: OneDrive
href: /connection-guides/documents/onedrive
```
- This ensures the new integration is discoverable in the documentation index.

- type: validate
conditions:
- pattern: "- name: [Ii]ntegration\\s*Name\\s*\\n\\s*href: \\/connection-guides\\/[a-z-]+\\/[a-z-]+"
path: "integrations.mdx"
message: "A new entry must be added to integrations.mdx with a redirect or link to the new guide."

examples:
- input: |
---
title: "Example Integration"
description: "Follow these steps to connect Example via the StackOne Hub successfully."
---

import IntegrationFooter from "/snippets/integration-footer.mdx"

<Warning>
Required permissions or prerequisites
</Warning>

Introduction paragraph explaining the integration process.

<Steps>
<Step title="First Step">
Instructions for first step

<Frame>
<img className='rounded-md' alt="Step description" src="/images/example/step-1.png" />
</Frame>
</Step>
</Steps>

## Linking your Provider Account

Now that you have all the required information, you can link your account.

<Steps>
<Step title="Access Integrations">
Navigate to the Integrations page in your platform.
</Step>

<Step title="Find Integration">
Search for the integration name in the list of available integrations and click on it.
</Step>

<Step title="Enter Connection Details">
Fill in the required fields with the information you gathered.
</Step>

<Step title="Test and Save">
Click Test Connection to verify the connection, then click Save to complete the integration.
</Step>
</Steps>

<IntegrationFooter />

## Available data

This integration has the following [CATEGORY Resources](mdc:https:/docs.stackone.com/reference/getting-started-with-your-api) available from the provider:
<ul>
<li>Resource1</li>
<li>Resource2</li>
</ul>

# integrations.mdx
- name: Example
href: /connection-guides/documents/example
output: "Valid hub documentation guide and index entry"

metadata:
priority: high
version: 1.3
category: documentation
applies_to: ["connection-guides/**/*.mdx", "integrations.mdx"]
</rule>

<!-- The following rules can be requested by agent by reading the filepath directly. -->

# Cursor Rules Location

>Standards for placing Cursor rule files in the correct
This refers to: *.mdc

Read the full rule [here](.cursor/rules/cursor-rules-location.md)

4 changes: 4 additions & 0 deletions connection-guides/lms/docebo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Docebo"
description: "If you've been directed to StackOne to integrate with Docebo, the following steps will help you understand the process and any necessary actions to configure successful integration."
---

import IntegrationFooter from "/snippets/integration-footer.mdx";

<Warning>
This guidance assumes you have Admin privileges for your Docebo account.
</Warning>
Expand Down Expand Up @@ -127,3 +129,5 @@ description: "If you've been directed to StackOne to integrate with Docebo, the
</Step>

</Steps>

<IntegrationFooter />
9 changes: 8 additions & 1 deletion integration-configuration-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,11 @@ import { IntegrationTile } from '/snippets/integration-tile.mdx';
<IntegrationTile logo={'https://mintlify.s3-us-west-1.amazonaws.com/stackone-hub/images/logo-cascadehr.png'} title={'CascadeHR Hierarchy Level Configuration'} category={'HRIS'} link={'/integration-configuration-concepts/hris/cascadehr-groups-mapping'} />
<IntegrationTile logo={'https://mintlify.s3-us-west-1.amazonaws.com/stackone-hub/images/logo-workdayats.png'} title={'Workday Skills'} category={'HRIS'} link={'/integration-configuration-concepts/hris/workday-skills'} />
<IntegrationTile logo={'https://mintlify.s3-us-west-1.amazonaws.com/stackone-hub/images/logo-workday.png'} title={'Workday Employee Custom Field'} category={'HRIS'} link={'/integration-configuration-concepts/hris/workday-employee-custom-field'} />
<IntegrationTile logo={'https://mintlify.s3-us-west-1.amazonaws.com/stackone-hub/images/logo-workday.png'} title={'Workday Calculated Fields'} category={'HRIS'} link={'/integration-configuration-concepts/hris/workday-calculated-fields'} />
<IntegrationTile logo={'https://mintlify.s3-us-west-1.amazonaws.com/stackone-hub/images/logo-workday.png'} title={'Workday Calculated Fields'} category={'HRIS'} link={'/integration-configuration-concepts/hris/workday-calculated-fields'} />

## IDP Configuration for SSO
<IntegrationTile logo={'https://stackone-logos.com/api/stackone/filled/png'} title={'SSO Configuration Overview'} category={'SSO'} link={'/integration-configuration-concepts/idp/sso-configuration-overview'} />
<IntegrationTile logo={'https://stackone-logos.com/api/okta/filled/png'} title={'Okta SSO Configuration'} category={'SSO'} link={'/integration-configuration-concepts/idp/okta-sso-configuration'} />
<IntegrationTile logo={'https://stackone-logos.com/api/azure-devops/icon/png'} title={'Azure AD SSO Configuration'} category={'SSO'} link={'/integration-configuration-concepts/idp/azure-ad-sso-configuration'} />
<IntegrationTile logo={'https://stackone-logos.com/api/google/filled/png'} title={'Google Workspace SSO Configuration'} category={'SSO'} link={'/integration-configuration-concepts/idp/google-workspace-sso-configuration'} />
<IntegrationTile logo={'https://stackone-logos.com/api/onelogin/filled/png'} title={'OneLogin SSO Configuration'} category={'SSO'} link={'/integration-configuration-concepts/idp/onelogin-sso-configuration'} />
Loading