Skip to content

Commit 9130180

Browse files
mintlify-development[bot]mintlify-development[bot]
authored
Documentation edits made through Mintlify web editor
1 parent 3ccba78 commit 9130180

File tree

107 files changed

+9288
-221
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+9288
-221
lines changed

‎docs.json‎

Lines changed: 393 additions & 221 deletions
Large diffs are not rendered by default.

‎id/advanced/dashboard/permissions.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Izin Editor
3+
description: Izinkan lebih banyak anggota tim Anda untuk memperbarui docs
4+
---
5+
6+
Anggota tim yang membuat docs awal Anda akan memiliki akses pembaruan ke docs Anda, selama mereka melakukan push ke repo dokumentasi Anda dengan akun GitHub yang sama yang digunakan saat mendaftar untuk Mintlify.
7+
8+
Jika editor lain mencoba memperbarui docs saat menggunakan paket gratis, Anda akan melihat peringatan dalam pemeriksaan git commit Anda.
9+
10+
<Frame>
11+
<img className="rounded-md" src="/images/editor-gate.png" />
12+
</Frame>
13+
14+
Dalam detail peringatan pemeriksaan git, Anda akan menemukan tautan untuk meningkatkan paket Anda. Anda juga dapat meningkatkan paket Anda di [dashboard](https://dashboard.mintlify.com) untuk mengaktifkan editor tak terbatas untuk memperbarui docs Anda. Setelah Anda meningkatkan paket, picu pembaruan manual atau push perubahan lain untuk menerapkan pembaruan Anda.
15+
16+
Pelajari lebih lanjut tentang harga kami [di sini](https://mintlify.com/pricing).

‎id/advanced/dashboard/sso.mdx‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: Single Sign-On (SSO)
3+
description: Sesuaikan cara tim Anda dapat masuk ke dasbor admin Anda
4+
---
5+
6+
Gunakan single sign-on ke dasbor Anda melalui SAML dan OIDC. Jika Anda menggunakan Okta atau Google Workspace, kami memiliki dokumentasi khusus penyedia untuk mengatur SSO, tetapi jika Anda menggunakan penyedia lain, silakan hubungi kami!
7+
8+
<Note>
9+
Fungsi SSO tersedia pada paket Enterprise kami.[Hubungi
10+
kami](https://mintlify.com/enterprise) untuk mempelajari lebih lanjut!
11+
</Note>
12+
13+
## Okta
14+
15+
<Tabs>
16+
<Tab title="SAML">
17+
<Steps>
18+
<Step title="Create an application">
19+
Di bawah `Applications`, klik untuk membuat integrasi aplikasi baru menggunakan SAML 2.0.
20+
</Step>
21+
22+
<Step title="Configure integration">
23+
Masukkan yang berikut:
24+
25+
* URL single sign-on (disediakan oleh Mintlify)
26+
* URI Audiens (disediakan oleh Mintlify)
27+
* Format ID Nama: `EmailAddress`
28+
* Pernyataan Atribut:
29+
| Nama | Format nama | Nilai |
30+
| ----------- | ----------- | ---------------- |
31+
| `firstName` | Dasar | `user.firstName` |
32+
| `lastName` | Dasar | `user.lastName` |
33+
</Step>
34+
35+
<Step title="Send us your IdP information">
36+
Setelah aplikasi diatur, navigasi ke tab sign-on dan kirimkan URL metadata kepada kami.
37+
Kami akan mengaktifkan koneksi dari sisi kami menggunakan informasi ini.
38+
</Step>
39+
</Steps>
40+
</Tab>
41+
42+
<Tab title="OIDC">
43+
<Steps>
44+
<Step title="Create an application">
45+
Di bawah `Applications`, klik untuk membuat integrasi aplikasi baru menggunakan OIDC.
46+
Anda harus memilih `Web Application` tipe aplikasi.
47+
</Step>
48+
49+
<Step title="Configure integration">
50+
Pilih tipe grant kode otorisasi dan masukkan URI Pengalihan yang disediakan oleh Mintlify.
51+
</Step>
52+
53+
<Step title="Send us your IdP information">
54+
Setelah aplikasi diatur, navigasi ke tab Umum dan temukan ID klien & rahasia klien.
55+
Mohon berikan kami informasi ini secara aman, bersama dengan URL instansi Okta Anda (misalnya `<your-tenant-name>.okta.com`). Anda dapat mengirimkan ini melalui layanan seperti 1Password atau SendSafely.
56+
</Step>
57+
</Steps>
58+
</Tab>
59+
</Tabs>
60+
61+
## Google Workspace
62+
63+
<Tabs>
64+
<Tab title="SAML">
65+
<Steps>
66+
<Step title="Create an application">
67+
Di bawah `Web and mobile apps`, pilih `Add custom SAML app` dari `Add app` dropdown.
68+
69+
<Frame>
70+
![](/images/gsuite-add-custom-saml-app.png)
71+
</Frame>
72+
</Step>
73+
74+
<Step title="Send us your IdP information">
75+
Salin URL SSO, ID Entitas, dan sertifikat x509 yang disediakan dan kirimkan ke tim Mintlify.
76+
77+
<Frame>
78+
![](/images/gsuite-saml-metadata.png)
79+
</Frame>
80+
</Step>
81+
82+
<Step title="Configure integration">
83+
Pada halaman detail Penyedia layanan, masukkan yang berikut:
84+
85+
* URL ACS (disediakan oleh Mintlify)
86+
* ID Entitas (disediakan oleh Mintlify)
87+
* Format ID Nama: `EMAIL`
88+
* ID Nama: `Basic Information > Primary email`
89+
90+
<Frame>
91+
![](/images/gsuite-sp-details.png)
92+
</Frame>
93+
94+
Pada halaman berikutnya, masukkan pernyataan atribut berikut:
95+
96+
| Atribut Direktori Google | Atribut Aplikasi |
97+
| ------------------------ | ---------------- |
98+
| `First name` | `firstName` |
99+
| `Last name` | `lastName` |
100+
101+
Setelah langkah ini selesai dan pengguna ditugaskan ke aplikasi, beri tahu tim kami dan kami akan mengaktifkan SSO untuk akun Anda!
102+
</Step>
103+
</Steps>
104+
</Tab>
105+
</Tabs>

‎id/advanced/mcp/generate.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: MCP Generator
3+
description: Pelajari cara menyiapkan Server MCP Anda sendiri
4+
icon: 'text-size'
5+
---
6+
7+
<Tip>
8+
Halaman ini didedikasikan untuk menyiapkan Server MCP Anda sendiri. Jika Anda mencari informasi tentang penggunaan Server Mintlify MCP, silakan merujuk ke
9+
[Menginstal dan menggunakan Server Mintlify MCP](/advanced/mcp/quickstart) halaman.
10+
</Tip>
11+
12+
## Memulai
13+
14+
Jalankan `npm i @mintlify/mcp` untuk menginstal `@mintlify/mcp` CLI.
15+
16+
Di [dasbor](https://dashboard.mintlify.com/products/mcp) pergi ke `MCP Server`, di halaman ini alihkan untuk melihat perintah instalasi unik Anda. Ini adalah perintah untuk menginstal Server MCP Anda dengan `@mintlify/mcp` CLI.
17+
18+
<Note>
19+
Pastikan untuk mengalihkan akses OpenAPI untuk memungkinkan server MCP mengakses **semua**
20+
endpoint dalam spesifikasi OpenAPI Anda.
21+
</Note>
22+
23+
## Memulai server MCP secara lokal
24+
25+
<Steps>
26+
<Step title="Install the server through the CLI">
27+
Jalankan perintah berikut untuk menginstal server:
28+
29+
```bash
30+
npx @mintlify/mcp add [your subdomain]
31+
```
32+
</Step>
33+
34+
<Step title="Add the authentication token if applicable">
35+
Jika API Anda memerlukan token autentikasi, beri tahu pelanggan akhir Anda untuk mendapatkannya dan menerapkannya ketika diberikan respons ini: `> What is the Authorization
36+
(basic token)?` Jika tidak, Anda dapat melewati langkah ini.
37+
</Step>
38+
39+
<Step title="Start your MCP server">
40+
Anda sekarang dapat menjalankan: `bash npm --prefix ~/.mcp/[your subdomain] start `
41+
</Step>
42+
</Steps>

‎id/advanced/mcp/quickstart.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Quickstart
3+
description: Menghasilkan server MCP untuk membantu menghubungkan produk Anda ke LLM
4+
---
5+
6+
## Pendahuluan
7+
8+
MCP Generator adalah alat CLI yang menghasilkan server MCP berdasarkan dokumentasi perusahaan Anda & spesifikasi OpenAPI jika tersedia. Ini mengambil dokumentasi Anda dan spesifikasi OpenAPI dan menghasilkan server MCP yang dapat digunakan dengan klien MCP apa pun. MCP Generator disampaikan melalui[paket npm](https://www.npmjs.com/package/mcp) dan menghasilkan server MCP yang dapat digunakan dengan klien MCP apa pun.
9+
10+
Mintlify memungkinkan Anda membuat server MCP yang memungkinkan alat AI berinteraksi dengan dokumentasi Anda dalam skenario kunci berikut:
11+
12+
1. **Docs Q\&A**, mirip dengan AI Chat kami. Ini secara otomatis diaktifkan untuk dokumentasi Anda, tidak diperlukan pengaturan.
13+
2. **Kueri API real-time**, jika Anda memiliki spesifikasi OpenAPI, buka`Mintlify Dashboard > Products > MCP Server` dan klik toggle untuk mengaktifkan spesifikasi OpenAPI Anda.
14+
15+
<Note>
16+
Dengan mengaktifkan toggle OpenAPI, Anda mengizinkan server MCP untuk mengakses
17+
**semua** endpoint dalam spesifikasi OpenAPI Anda.
18+
</Note>
19+
20+
## Instal server MCP
21+
22+
<Tip>
23+
Halaman ini didedikasikan untuk Server MCP Mintlify. Jika Anda mencari informasi tentang cara menghasilkan MCP Anda, silakan lihat halaman[MCP Generator](/advanced/mcp/generate).
24+
</Tip>
25+
26+
## Contoh instalasi dengan server MCP Mintlify
27+
28+
Untuk menggunakan server MCP Mintlify Anda akan memerlukan[kunci API](https://mintlify.com/docs/advanced/rest-api/overview#authentication) dari akun Mintlify Anda. Jika Anda belum memilikinya, navigasikan ke`Settings > API Keys > Chat API Key` dan buat kunci baru.
29+
30+
## Mulai server MCP secara lokal
31+
32+
<Steps>
33+
<Step title="Install the server through the CLI">
34+
Jalankan perintah berikut untuk menginstal server:
35+
36+
```bash
37+
npx @mintlify/mcp add mintlify
38+
```
39+
</Step>
40+
41+
<Step title="Add the authentication token">
42+
Respons berikut akan diberikan setelah menjalankan perintah sebelumnya:
43+
44+
```
45+
> What is the Authorization (basic token)?
46+
```
47+
48+
Menggunakan kunci chat API Anda, salin token autentikasi dan tempelkan ke dalam CLI.
49+
</Step>
50+
51+
<Step title="Start your MCP server">
52+
Anda sekarang dapat menjalankan:
53+
54+
```bash
55+
npm --prefix ~/.mcp/mintlify start
56+
```
57+
</Step>
58+
</Steps>
59+
60+
## Gunakan server Anda dengan Claude
61+
62+
<Note>
63+
Unduh[Aplikasi Desktop Claude](https://claude.ai/download)
64+
</Note>
65+
66+
Setelah Anda menginstal Aplikasi Desktop Claude, ikuti langkah-langkah berikut:
67+
68+
<Steps>
69+
<Step title="Navigate to the Settings > Developer" />
70+
71+
<Step title="Click on Edit Config">
72+
Tambahkan yang berikut ke`claude_desktop_config.json`:
73+
74+
```json
75+
{
76+
"mcpServers": {
77+
"mintlify": {
78+
"command": "npm",
79+
"args": [
80+
"--prefix",
81+
"~/.mcp/mintlify",
82+
"start"
83+
]
84+
}
85+
}
86+
}
87+
```
88+
</Step>
89+
90+
<Step title="If you see the hammer icon, you're all set!">
91+
Jika Anda mengkliknya, Anda akan melihat MCP Tools yang tersedia di server Anda.
92+
93+
<Frame>
94+
![Claude MCP](/images/mcp-with-claude.png)
95+
</Frame>
96+
</Step>
97+
</Steps>

‎id/advanced/rest-api/chat/create-topic.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/topic
3+
---

‎id/advanced/rest-api/chat/generate-message.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/message
3+
---

‎id/advanced/rest-api/overview.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Overview
3+
---
4+
5+
## Memicu Pembaruan
6+
7+
Anda dapat memanfaatkan REST API untuk memicu pembaruan secara terprogram saat diinginkan.
8+
9+
<Info>
10+
Meskipun kasus penggunaan utama akan menjadi memicu pembaruan, kami akan menambahkan lebih banyak
11+
fungsionalitas ke API seiring waktu. Beri tahu kami apa lagi yang ingin Anda lihat di
12+
[komunitas kami](https://mintlify.com/community)!
13+
</Info>
14+
15+
## Autentikasi
16+
17+
Anda dapat menghasilkan kunci API melalui
18+
[dasbor](https://dashboard.mintlify.com/settings/organization/api-keys). Kunci API tersebut terkait dengan seluruh organisasi dan dapat digunakan di berbagai deployment.
19+
20+
<Frame>
21+
<img src="/images/external-api-key.png" />
22+
</Frame>
23+
24+
## Kunci API Admin
25+
26+
Kunci API Admin digunakan untuk sebagian besar API. Ini digunakan untuk memicu pembaruan melalui [endpoint Pembaruan](/advanced/rest-api/update/trigger).
27+
28+
## Kunci API Chat
29+
30+
API Chat memungkinkan Anda untuk menyematkan pengalaman chat AI yang didasarkan pada dokumentasi Anda dan terus diperbarui ke dalam aplikasi pilihan Anda.
31+
32+
Respons mencakup kutipan sehingga Anda dapat mengarahkan pengguna ke tempat yang tepat untuk mendapatkan bantuan.
33+
34+
<Note>
35+
Token API Chat adalah token publik yang dapat direferensikan dalam kode frontend Anda sedangkan kunci API adalah token sisi server yang harus dijaga kerahasiaannya.
36+
</Note>
37+
38+
Sekarang Anda memiliki kunci API, lihat [contoh](https://github.com/mintlify/discovery-api-example) kami untuk cara menggunakan API untuk AI chat. Anda juga dapat melihat versi yang sudah di-deploy di [chat.mintlify.com](https://chat.mintlify.com).

‎id/advanced/rest-api/update/status.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: GET /project/update-status/{statusId}
3+
---

‎id/advanced/rest-api/update/trigger.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /project/update/{projectId}
3+
---

0 commit comments

Comments
 (0)