Restructure docs quickstart #2491
Merged
Conversation
This file contains hidden or 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
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </Step> | ||
| <Step title="Customize your docs"> | ||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'Now' that become outdated
| </Info> | ||
| ## Explore Fern's features | ||
|
|
||
| Now that your docs are live, explore these features to enhance them further. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'Now' that become outdated
Contributor
Ryan-Amirthan
requested changes
Dec 3, 2025
| fern generate --docs | ||
| ``` | ||
|
|
||
| This command builds your documentation at `https://YourOrganization.docs.buildwithfern.com`, where `YourOrganization` is the name defined in `fern.config.json`. |
Contributor
There was a problem hiding this comment.
where
YourOrganization
the url that the site is published at is configured in docs.yml like so:
instances:
- url: merge-test.docs.buildwithfern.com # update this to {yourorg}.docs.buildwithfern.com
Does not necessarily have to be the org name in your fern.config.json
Contributor
There was a problem hiding this comment.
would make that a little more clear here, and at the start of the page too.
Contributor
Ryan-Amirthan
approved these changes
Dec 3, 2025
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.
No description provided.