@devries-cameron20 / composio Mirror · read-only / commits / 3741fea62
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, 22:00 UTC

Update README.md

balyan.sid@gmail.com committed Jul 4, 2025 at 11:12 UTC 3741fea6273965ae0187689b1209cdae82baa0e0
1 file changed +13 -67
fern/README.md
+13 -67
@@ -36,7 +36,7 @@ cd composio1/fern
36 pnpm install
37 ```
38
39 -### 3. Install UV (Python Package Manager)
39 +### 3. Install Python Dependencies
40
41 UV is required for generating tool and Python documentation:
42
@@ -44,6 +44,11 @@ UV is required for generating tool and Python documentation:
44 curl -LsSf https://astral.sh/uv/install.sh | sh
45 ```
46
47 +**Install the Python SDK**
48 +```bash
49 +uv sync && uv pip install python/
50 +```
51 +
52 ### 4. Install and Setup Fern CLI
53
54 Fern is the documentation framework we use:
@@ -63,21 +68,6 @@ export COMPOSIO_API_KEY=your_api_key_here
68
69 **Pro tip:** Add this to your shell profile (`.bashrc`, `.zshrc`, etc.) so you don't have to set it every time.
70
66 -### 6. Initial Content Generation
67 -
68 -Generate all the necessary documentation content:
69 -
70 -```bash
71 -# Download the latest OpenAPI specifications
72 -pnpm api:pull
73 -
74 -# Generate tool documentation
75 -pnpm run tools:generate
76 -
77 -# Generate SDK reference documentation
78 -pnpm run sdkdocs
79 -```
80 -
71 ## Development Workflow
72
73 Once you've completed the one-time setup, use this workflow for ongoing development:
@@ -85,7 +75,7 @@ Once you've completed the one-time setup, use this workflow for ongoing developm
75 ### 1. Start the Development Server
76
77 ```bash
88 -pnpm run dev
78 +pnpm turbo run dev
79 ```
80
81 This will:
@@ -96,7 +86,9 @@ This will:
86
87 ### 2. Make Your Changes
88
99 -Edit the documentation files in the appropriate directories. The server will automatically reload when you make changes.
89 +- Edit the documentation files in the `fern/pages/src` directories.
90 +- If adding new docs, make sure to add them in `docs.yml`
91 +- Refer to [Fern docs](https://buildwithfern.com/learn/docs/getting-started/overview)
92
93 ### 3. Check Your Work
94
@@ -104,10 +96,10 @@ Before submitting your changes, run these commands to ensure everything is worki
96
97 ```bash
98 # Check for broken links and other issues
107 -pnpm run links
99 +cd fern/ && pnpm run links
100
101 # Or use the check command (faster, but comments out tool docs)
110 -pnpm run check
102 +cd fern/ && pnpm run check
103 ```
104
105 ### 4. Submit Your Changes
@@ -115,50 +107,4 @@ pnpm run check
107 1. Commit your changes to a new branch
108 2. Push to your fork
109 3. Create a pull request
118 -
119 -## Troubleshooting
120 -
121 -### Common Issues and Solutions
122 -
123 -**Problem:** `uv: command not found`
124 -**Solution:** Make sure UV is installed and restart your terminal after installation.
125 -
126 -**Problem:** `fern: command not found`
127 -**Solution:** Install Fern globally with `npm install -g fern-api`
128 -
129 -**Problem:** Tool generation fails
130 -**Solution:** Make sure your `COMPOSIO_API_KEY` environment variable is set correctly.
131 -
132 -**Problem:** Development server won't start
133 -**Solution:**
134 -
135 -1. Make sure all dependencies are installed: `pnpm install`
136 -2. Try cleaning and rebuilding: `pnpm clean && pnpm install`
137 -
138 -**Problem:** Broken links in documentation
139 -**Solution:** Run `pnpm run links` to identify and fix broken links before submitting.
140 -
141 -### Development Commands Reference
142 -
143 -| Command | Purpose |
144 -| ------------------------- | ------------------------------------------ |
145 -| `pnpm run dev` | Start development server with fast preview |
146 -| `pnpm run links` | Check for broken links (full build) |
147 -| `pnpm run check` | Quick validation (comments out tool docs) |
148 -| `pnpm run tools:generate` | Generate tool documentation |
149 -| `pnpm run sdkdocs` | Generate SDK reference docs |
150 -| `pnpm api:pull` | Download latest OpenAPI specs |
151 -| `pnpm run preview` | Generate full preview build |
152 -| `pnpm run publish` | Publish docs (maintainers only) |
153 -
154 -### File Structure
155 -
156 -```
157 -fern/
158 -├── docs/ # Main documentation content
159 -├── assets/ # Images, CSS, and other assets
160 -├── pages/ # Documentation pages
161 -├── generators/ # Tool documentation generators
162 -├── scripts/ # Build and utility scripts
163 -└── package.json # Dependencies and scripts
164 -```
110 +5. You will see preview links generated in the PR, use that to share.