https://github.com/devrev/fern-api-docs
The Fern configuration for generating DevRev Docs.
https://github.com/devrev/fern-api-docs
Last synced: 2 months ago
JSON representation
The Fern configuration for generating DevRev Docs.
- Host: GitHub
- URL: https://github.com/devrev/fern-api-docs
- Owner: devrev
- Archived: true
- Created: 2023-04-26T19:04:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-24T22:17:33.000Z (5 months ago)
- Last Synced: 2026-01-16T18:15:14.440Z (2 months ago)
- Language: MDX
- Homepage:
- Size: 27.1 MB
- Stars: 0
- Watchers: 15
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.py
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# DevRev Docs
Merging a change in this repository will update the following clients:
- [API Docs](https://developer.devrev.ai)
This repository contains
- DevRev's `Public` OpenAPI spec & `Beta` OpenAPI spec
- Fern configuration
## API definition
The API Definition contains an OpenAPI specification adapted to be compatible with Fern. The specs are in `/fern/apis`.
To make sure that the definition is valid, you can use the Fern CLI.
```bash
npm install -g fern-api # Installs CLI
fern check # Checks if the definition is valid
```
## Generators
Generators read in your API Definition and output artifacts (the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/api/generators.yml).
To trigger the generators run:
```bash
# publish generated files
fern generate --version
```
## Run a local instance
In the root of this repository:
```
cd custom-implementation/ && yarn && yarn build && cd ..
fern docs dev
```
### Troubleshooting
If you run into errors, you can add the ` --log-level debug` flag to get more information.
## Stylecheck (Beta)
The `stylecheck.py` script sends a markdown file to Claude Sonnet for revision according to defined style, structure, and terminology rules.
### GitHub action
If a PR has the label `stylecheck` and not the label `stylecheck-complete`, the `stylecheck.py` script runs on any `.md(x)` files changed in the PR. A summary of changes is posted as a comment on the timeline. Suggestions for the diff context are added. If there are any proposed revisions outside the diff context, the full text of the revision is included in the summary comment.
When the action completes, it adds the `stylecheck-complete` tag. If you want stylecheck to run on new changes on a PR where it has already run, remove the `stylecheck-complete` label before pushing the new changes.
### Local execution
To run the script locally and not as part of a PR, set your environment variable `LLM_TOKEN` to your PAT from [OpenWebUI](https://openwebui.dev.devrev-eng.ai/) > **Settings** > **Account** > API Keys. Include the supplemental developer style rules with the `--style` option.
```
python stylecheck.py --style=style/developer.md
```