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

docs: update README #35

Merged
merged 1 commit into from
Feb 14, 2024
Merged

docs: update README #35

merged 1 commit into from
Feb 14, 2024

Conversation

minaelee
Copy link
Contributor

  • Added Requirements section
  • Had user name new repo 'fern-docs' instead of saying "something like", to simplify the experience by having them make less decisions
  • Removed fern check since not needed for this QS as we supply the OpenAPI spec file, again to simplify the experience
  • Removed step on using your own OpenAPI specification file. fern init --openapi command will fail if you run it the way that step suggests, with error message that openapi/ folder already exists. Also, the step on customizing tells users how to use their own OpenAPI file.
  • Edited step on customizing to provide more details and direct users to Writing Content page for information on how to change docs.yml for navigation and custom styles.

@dannysheridan
Copy link
Member

nice clarity on the Advanced options!

@dannysheridan dannysheridan merged commit 3aca2ed into fern-api:main Feb 14, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants