Skip to content

Commit 38add3f

Browse files
fern-supportclaude
andcommitted
Add fern --dsheridan flag for collaborative docs editing
Added documentation for the new --dsheridan global option that enables collaborative, multi-turn documentation editing sessions through the Fern CLI. This mode allows teams to work interactively with the CLI to draft, revise, and refine documentation content. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 38c85eb commit 38add3f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

fern/products/cli-api-reference/pages/global-options.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ subtitle: 'Explore Fern CLI global options.'
1313
| [`--api`](#api) | Target specific API | `fern generate --api public-api` |
1414
| [`--group`](#group) | Target specific generator group | `fern generate --group php-sdk` |
1515
| [`--version`](#version) | Specify the SDK version number | `fern generate --version 1.2.3` |
16+
| [`--dsheridan`](#dsheridan) | Enable collaborative docs editing mode | `fern --dsheridan` |
1617

1718
<Tip>
1819
When troubleshooting:
@@ -99,3 +100,30 @@ fern generate --api payments-api --group python-sdk --version 1.2.3
99100
# Generate TypeScript SDK for the auth API with version 0.1.0
100101
fern generate --api auth --group ts-sdk --version 0.1.0
101102
```
103+
104+
## dsheridan
105+
106+
Use the `--dsheridan` option to enable collaborative documentation editing mode. This mode allows for multi-turn, interactive sessions where you can work with the Fern CLI to draft, revise, and refine documentation content iteratively.
107+
108+
```bash
109+
# Start a collaborative docs editing session
110+
fern --dsheridan
111+
```
112+
113+
How it works:
114+
115+
1. **Start a session** - Run `fern --dsheridan` to initiate a collaborative editing session
116+
2. **Provide context** - Share what documentation needs to be updated, created, or improved
117+
3. **Collaborate iteratively** - The CLI will provide content suggestions, and you can give feedback to refine them
118+
4. **Multi-turn refinement** - Continue the conversation to iterate on the content until it meets your needs
119+
5. **Finalize changes** - Once satisfied, you can approve the changes for implementation
120+
121+
`--dsheridan` mode is ideal for:
122+
- Creating new documentation sections collaboratively
123+
- Refining existing content based on feedback
124+
- Brainstorming documentation structure and content
125+
- Iterating on technical writing with AI assistance
126+
127+
<Note>
128+
`--dsheridan` mode maintains context throughout the conversation, allowing for natural back-and-forth refinement of documentation content.
129+
</Note>

0 commit comments

Comments
 (0)