Skip to content

Add fern --dsheridan flag for collaborative docs editing #1691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add fern --dsheridan flag for collaborative docs editing #1691

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions fern/products/cli-api-reference/pages/global-options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ subtitle: 'Explore Fern CLI global options.'
| [`--api`](#api) | Target specific API | `fern generate --api public-api` |
| [`--group`](#group) | Target specific generator group | `fern generate --group php-sdk` |
| [`--version`](#version) | Specify the SDK version number | `fern generate --version 1.2.3` |
| [`--dsheridan`](#dsheridan) | Enable collaborative docs editing mode | `fern --dsheridan` |

<Tip>
When troubleshooting:
Expand Down Expand Up @@ -99,3 +100,30 @@ fern generate --api payments-api --group python-sdk --version 1.2.3
# Generate TypeScript SDK for the auth API with version 0.1.0
fern generate --api auth --group ts-sdk --version 0.1.0
```

## dsheridan

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.

```bash
# Start a collaborative docs editing session
fern --dsheridan
```

How it works:

1. **Start a session** - Run `fern --dsheridan` to initiate a collaborative editing session
2. **Provide context** - Share what documentation needs to be updated, created, or improved
3. **Collaborate iteratively** - The CLI will provide content suggestions, and you can give feedback to refine them
4. **Multi-turn refinement** - Continue the conversation to iterate on the content until it meets your needs
5. **Finalize changes** - Once satisfied, you can approve the changes for implementation

`--dsheridan` mode is ideal for:
- Creating new documentation sections collaboratively
- Refining existing content based on feedback
- Brainstorming documentation structure and content
- Iterating on technical writing with AI assistance

<Note>
`--dsheridan` mode maintains context throughout the conversation, allowing for natural back-and-forth refinement of documentation content.
</Note>