@devries-cameron20 / composio Mirror · read-only / commits / 948d40c1b
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 22, 15:45 UTC

bun install guide

Sushmithamallesh committed Jan 1, 2026 at 21:58 UTC 948d40c1b1f2bb6e6f6e13471633145cade385b0
1 file changed +114
fumadocs/CONTRIBUTING.md new
+114
@@ -0,0 +1,114 @@
1 +# Contributing to Composio Docs
2 +
3 +## Prerequisites
4 +
5 +- [Bun](https://bun.sh/) (v1.0+)
6 +- Node.js 18+
7 +
8 +## Getting Started
9 +
10 +### 1. Install dependencies
11 +
12 +```bash
13 +bun install
14 +```
15 +
16 +### 2. Run the dev server
17 +
18 +```bash
19 +bun run dev
20 +```
21 +
22 +The docs will be available at [http://localhost:3000](http://localhost:3000).
23 +
24 +### 3. Build for production
25 +
26 +```bash
27 +bun run build
28 +```
29 +
30 +## Project Structure
31 +
32 +```
33 +fumadocs/
34 +├── app/ # Next.js app router pages
35 +│ └── (home)/ # Main docs routes
36 +│ ├── docs/ # /docs section
37 +│ ├── tool-router/ # /tool-router section
38 +│ ├── examples/ # /examples section
39 +│ └── ...
40 +├── content/ # MDX content files
41 +│ ├── docs/ # Docs pages
42 +│ ├── tool-router/ # Tool Router pages
43 +│ ├── examples/ # Examples pages
44 +│ └── ...
45 +├── components/ # React components
46 +├── lib/ # Utilities and source config
47 +└── public/ # Static assets
48 +```
49 +
50 +## Adding/Editing Content
51 +
52 +### Adding a new page
53 +
54 +1. Create a new `.mdx` file in the appropriate `content/` folder
55 +2. Add frontmatter with `title` and `description`
56 +3. Add the page to the folder's `meta.json`
57 +
58 +Example:
59 +
60 +```mdx
61 +---
62 +title: My New Page
63 +description: A brief description
64 +---
65 +
66 +Your content here...
67 +```
68 +
69 +### Using components
70 +
71 +Common components available in MDX:
72 +
73 +```mdx
74 +<Tabs items={['Python', 'TypeScript']}>
75 + <Tab value="Python">Python code here</Tab>
76 + <Tab value="TypeScript">TypeScript code here</Tab>
77 +</Tabs>
78 +
79 +<Callout type="info">Important information</Callout>
80 +
81 +<Steps>
82 + <Step>### Step 1</Step>
83 + <Step>### Step 2</Step>
84 +</Steps>
85 +
86 +<Cards>
87 + <Card title="Title" href="/path" />
88 +</Cards>
89 +```
90 +
91 +## Sidebar Configuration
92 +
93 +Each content folder has a `meta.json` that controls sidebar order:
94 +
95 +```json
96 +{
97 + "title": "Section Title",
98 + "pages": [
99 + "---Section Header---",
100 + "page-one",
101 + "page-two",
102 + "nested-folder"
103 + ]
104 +}
105 +```
106 +
107 +## Common Commands
108 +
109 +| Command | Description |
110 +|---------|-------------|
111 +| `bun run dev` | Start dev server |
112 +| `bun run build` | Production build |
113 +| `bun run start` | Start production server |
114 +| `bun run types:check` | Type check |