fern-docs/fern/docs/user-guide.yml at 983f29ba3e44de60caec3f57260c778c5b85f2f3 · Credal-ai/fern-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
navigation:
  - section: Getting Started
    contents:
      - page: Introduction
        path: ./pages/introduction.mdx
      - page: Quickstart
        slug: quickstart
        path: ./pages/quickstart.mdx
      - page: Agent Building Tutorial Video
        path: ./pages/agent-building.mdx
      - section: "Tutorials: Common First Agents"
        contents:
          - section: Employee Onboarding Assistant
            contents:
              - page: Overview
                path: ./pages/tutorials/employee-onboarding/overview.mdx
              - page: Answer Basic Questions
                path: ./pages/tutorials/employee-onboarding/version-1.mdx
              - page: Searching Internal and External Knowledge
                path: ./pages/tutorials/employee-onboarding/version-2.mdx
              - page: Connect with Internal Systems
                path: ./pages/tutorials/employee-onboarding/version-3.mdx
          - section: IT Security Assistant
            contents:
              - page: Overview
                path: ./pages/tutorials/it-security/overview.mdx
              - page: Answer Questions with Data
                path: ./pages/tutorials/it-security/use-data.mdx
              - page: Track Tickets in Jira
                path: ./pages/tutorials/it-security/connect-to-jira.mdx
              - page: Publish to Slack
                path: ./pages/tutorials/it-security/deploy-to-slack.mdx
          - section: Snowflake Query Assistant
            contents:
              - page: Overview
                path: ./pages/tutorials/snowflake-query/overview.mdx
              - page: Initial Snowflake Setup
                path: ./pages/tutorials/snowflake-query/initial-setup.mdx
              - page: Query Approaches
                path: ./pages/tutorials/snowflake-query/query-approaches.mdx
              - page: Testing your solution
                path: ./pages/tutorials/snowflake-query/testing-solution.mdx
          - section: Salesforce Query Assistant
            contents:
              - page: Overview
                path: ./pages/tutorials/salesforce-query/salesforce-example.mdx
      - page: FAQs
        path: ./pages/getting-started/faqs.mdx
  - section: Platform
    contents:
      - section: Agent Builder
        contents:
          - section: Configuration
            contents:
              - page: Setting Up An Agent
                path: ./pages/platform/agents/configure-steps/agent-setup-page.mdx
              - page: Choosing a Model
                path: ./pages/platform/agents/configure-steps/ai-model.mdx
              - page: Writing Instructions
                path: ./pages/platform/agents/configure-steps/prompt.mdx
              - section: Add Connectors
                contents:
                  - page: Overview
                    path: ./pages/platform/agents/configure-steps/connectors/overview.mdx
                  - page: Data
                    path: ./pages/platform/agents/configure-steps/connectors/data.mdx
                  - page: Actions
                    path: ./pages/platform/agents/configure-steps/connectors/saas.mdx
                  - page: Document Collections
                    path: ./pages/platform/agents/configure-steps/connectors/document-collections.mdx
                  # - page: Credal MCP Servers
                  #   path: ./pages/platform/agents/configure-steps/connectors/mcp-servers.mdx
              - page: Agent Collaboration
                path: ./pages/platform/agents/configure-steps/agent-collaboration.mdx
              - page: Memory and Feedback
                path: ./pages/platform/agents/configure-steps/agent-feedback.mdx
          - page: Testing Your Agent
            path: ./pages/platform/agents/agent-testing.mdx
          - page: Evaluating Your Agent
            path: ./pages/platform/agents/agent-evaluate.mdx
          - section: Publishing Agents
            contents:
              - page: Overview
                path: ./pages/platform/agents/deployment/overview.mdx
              - page: Agents in Slack
                path: ./pages/platform/agents/deployment/slack-deployment.mdx
              - page: Custom Dedicated Slack Bots
                path: ./pages/platform/agents/deployment/slack-app-manifest.mdx
              - page: Slack Workflow Automation
                path: ./pages/tutorials/slack-workflows/slack-workflows.mdx
              - page: API Deployment
                path: ./pages/platform/agents/deployment/api-deployment.mdx
      - section: Governed Actions
        contents:
          - page: Overview
            path: ./pages/platform/actions/overview.mdx
          - page: Open Source Actions
            path: ./pages/platform/actions/open-source-actions.mdx
          - page: Credentials and Security
            path: ./pages/platform/actions/action-security-model.mdx
          - page: Human Approval Options
            path: ./pages/platform/actions/action-human-approval.mdx
          - page: Action Parameters
            path: ./pages/platform/actions/action-parameters.mdx
      - section: MCP Servers
        contents:
          - page: Overview
            path: ./pages/platform/mcp-servers/overview.mdx
          - section: MCP Server Builder
            contents:
              - page: Create a new Server
                path: ./pages/platform/mcp-servers/mcp-server-builder/create-new-server.mdx
              - page: Attaching connectors
                path: ./pages/platform/mcp-servers/mcp-server-builder/attaching-connectors.mdx
              - page: Connecting Agents
                path: ./pages/platform/mcp-servers/mcp-server-builder/connecting-agents.mdx
          - section: Import a Server
            contents:
              - page: Third-party Server Registration
                path: ./pages/platform/mcp-servers/import-server/third-party-registration.mdx
              - page: Setting up Controls
                path: ./pages/platform/mcp-servers/import-server/setting-up-controls.mdx
          - page: Testing your Server
            path: ./pages/platform/mcp-servers/testing-server.mdx
          - page: Publishing your Server
            path: ./pages/platform/mcp-servers/publishing-server.mdx
          - page: Monitoring Usage
            path: ./pages/platform/mcp-servers/monitoring-usage.mdx
      - page: Bulk Analysis
        # Soon to be turned into workflows, but the credal way :)
        path: ./pages/platform/bulk-analysis.mdx
      - section: Integrations
        # Soon to be renamed Document Collections
        contents:
          - page: Data Sources / Action Providers
            path: ./pages/platform/integrations/data-sources.mdx
          - section: Metadata and Smart Filtering
            contents:
              - page: Smart Filtering (beta)
                path: ./pages/platform/integrations/metadata-and-smart-filtering/smart-filtering.mdx
              - page: Collection Schemas
                path: ./pages/platform/integrations/metadata-and-smart-filtering/collection-schemas.mdx
              - page: AI Entity Extraction (beta)
                path: ./pages/platform/integrations/metadata-and-smart-filtering/ai-entity-extraction.mdx
          - page: Bring Your Own Custom Data Sources
            path: ./pages/platform/integrations/bring-your-own-data.mdx
      - section: Administration
        # Soon to be renamed Admin Control Center
        contents:
          - page: Single Sign-On (SSO)
            path: ./pages/administration/sso.mdx
          - page: Audit Log / Data Exports
            path: ./pages/administration/audit-log-data-exports.mdx
      # coming soon... Enterprise search