docs: update docs quickstart for petstore openapi #2882
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
minaelee
changed the title
minaelee
commented
Feb 8, 2024
| fern/ | ||
| ├─ docs/ | ||
| ├─ assets/ | ||
| ├─ pages/ |
There was a problem hiding this comment.
Suggested change
| ├─ pages/ | |
| └─ pages/ |
minaelee
commented
Feb 8, 2024
| ├─ assets/ | ||
| ├─ pages/ | ||
| ├─ sdks.mdx | ||
| ├─ welcome.mdx |
There was a problem hiding this comment.
Suggested change
| ├─ welcome.mdx | |
| └─ welcome.mdx |
minaelee
commented
Feb 8, 2024
| ├─ sdks.mdx | ||
| ├─ welcome.mdx | ||
| ├─ openapi/ | ||
| ├─ openapi.yaml |
There was a problem hiding this comment.
Suggested change
| ├─ openapi.yaml | |
| └─ openapi.yaml |
minaelee
commented
Feb 8, 2024
| ├─ openapi.yaml | ||
| ├─ docs.yml | ||
| ├─ fern.config.json | ||
| ├─ generators.yml |
There was a problem hiding this comment.
Suggested change
| ├─ generators.yml | |
| └─ generators.yml |
minaelee
commented
Feb 8, 2024
|
|
||
| Further tailor your documentation to match your brand by adjusting settings in the `docs.yml` file. | ||
| To update the API Reference section: | ||
| - Update or replace the file in the `openapi` folder. |
There was a problem hiding this comment.
Suggested change
| - Update or replace the file in the `openapi` folder. | |
| - Update or replace the file in the `openapi/` folder. |
|
Closing per splitting into 2 quickstarts for Docs with openapi and Docs with ferndef |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is contingent on updating the Fern Docs Starter template to include an
openapi/folder withopenapi.yamlfile for Swagger Petstore spec and deleting thedefinitions/folder. Will submit PR in that repo and link here.EDIT: Fern Docs Starter PR: fern-api/docs-starter#19