Skip to content
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.

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

[Bug] Frustrating error message when running fern generate --docs #3371

Open
alexrejto opened this issue Apr 13, 2024 · 0 comments
Open

[Bug] Frustrating error message when running fern generate --docs #3371

alexrejto opened this issue Apr 13, 2024 · 0 comments
Assignees
Labels
fern docs Improvements to the Fern Docs product

Comments

@alexrejto
Copy link
Contributor

Describe the Bug

I was trying to try out the docs page. But, because I have two apis in an apis/ directory, I got an unfriendly error like Cannot find api referenced in API Reference. But there was no mention of the ability to set an api-name on that object.

I needed to do this

  - api: API Reference
    api-name: public-api

Information to Reproduce

CLI Version

The version of the Fern CLI you are
using (found in fern.config.json).

Actual Behavior

The buggy behavior that is produced.

Expected Behavior

What you wanted to happen. Please share a preview link or screenshot of the expected behavior.

API Definition (if relevant)

The minimal OpenAPI specification or Fern definition required to reproduce the bug.

types:
  Pet:
    name: string
    age: double

Additional Context

Add any other context about the problem here.

@alexrejto alexrejto added the fern docs Improvements to the Fern Docs product label Apr 13, 2024
@alexrejto alexrejto changed the title [Bug] Frustrating error message in docs.yml [Bug] Frustrating error message when running fern generate --docs Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fern docs Improvements to the Fern Docs product
Development

No branches or pull requests

2 participants