Revamp docs-starter with instructional content #87
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
- Rewrite welcome page to introduce the starter template - Add 'Edit your docs' page covering CLI and Fern Editor - Add 'Set up navigation' page explaining docs.yml structure - Add 'Customize your docs' page for branding and theming - Add 'Support' page with Fern contact information - Add API reference landing page explaining supported specs - Update navigation structure in docs.yml - Remove placeholder pages (capabilities, tutorials, etc.) - Update snippets/note.mdx with appropriate content Co-Authored-By: Sarah Bawabe <[email protected]>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
sbawabe
commented
Dec 13, 2025
sbawabe
commented
Dec 13, 2025
sbawabe
commented
Dec 13, 2025
sbawabe
commented
Dec 13, 2025
sbawabe
commented
Dec 13, 2025
- Convert CLI and Fern Editor sections to Accordion items in editing-your-docs.mdx - Move Writing content section to new dedicated page (writing-content.mdx) - Simplify customization.mdx with visual card gallery linking to Fern docs - Simplify navigation.mdx with visual card gallery linking to Fern docs - Update git clone URL to placeholder in welcome.mdx - Update docs.yml navigation to include new Write content page Co-Authored-By: Sarah Bawabe <[email protected]>
sbawabe
commented
Dec 13, 2025
sbawabe
commented
Dec 13, 2025
- Change 'Get a demo' navbar button to 'Dashboard' linking to dashboard.buildwithfern.com - Simplify support.mdx: contact section at top with Slack and contact form, less prominent GitHub issues section below - Remove Fern Dashboard section from support page (now in navbar) Co-Authored-By: Sarah Bawabe <[email protected]>
sbawabe
commented
Dec 15, 2025
sbawabe
commented
Dec 15, 2025
- Change title from 'Welcome to the Fern docs starter' to 'Welcome to Fern!' - Change subtitle to action-oriented tagline: 'Everything you need to build the best developer experience' Co-Authored-By: Sarah Bawabe <[email protected]>
sbawabe
commented
Dec 15, 2025
sbawabe
commented
Dec 15, 2025
- Add third column with Fern docs links to supported specifications table - Delete 'Explore the Plant Store API' section (not needed) Co-Authored-By: Sarah Bawabe <[email protected]>
- Update colors to Fern's green primary (#70E155 dark, #008700 light) with white background - Replace logo with user-provided SVG - Add third column with Fern docs links to supported specifications table - Delete 'Explore the Plant Store API' section (not needed) Co-Authored-By: Sarah Bawabe <[email protected]>
| | **OpenAPI** | The most widely used REST API specification format (versions 3.0 and 3.1) | [OpenAPI docs](https://buildwithfern.com/learn/api-definitions/openapi/overview) | | ||
| | **AsyncAPI** | For event-driven and message-based APIs | [AsyncAPI docs](https://buildwithfern.com/learn/api-definitions/asyncapi) | | ||
| | **gRPC** | Protocol buffer definitions for gRPC services | [gRPC docs](https://buildwithfern.com/learn/api-definitions/protobuf) | | ||
| | **Fern Definition** | Fern's native YAML-based API definition format | [Fern Definition docs](https://buildwithfern.com/learn/api-definitions/fern-definition/overview) | |
Member
There was a problem hiding this comment.
Let's remove. Don't want to advertise this as customers don't adopt it highly.
Down to keep gRPC (though less than 5% of users care about it)
…dback Co-Authored-By: Sarah Bawabe <[email protected]>
|
|
||
| | Format | Description | Documentation | | ||
| |--------|-------------|---------------| | ||
| | **OpenAPI** | The most widely used REST API specification format (versions 3.0 and 3.1) | [OpenAPI docs](https://buildwithfern.com/learn/api-definitions/openapi/overview) | |
Member
There was a problem hiding this comment.
If including versions we support, I'd mention OpenAPI 2.0, 3.0, and 3.1
…R feedback Co-Authored-By: Sarah Bawabe <[email protected]>
| - section: Changelog | ||
| contents: | ||
| - changelog: docs/changelog | ||
| - tab: API Reference |
Member
There was a problem hiding this comment.
@sbawabe want to add:
- OpenAPI overrides (estimate of 30% of users use it)
- an AsyncAPI spec (estimate of 10% of users use it)
devalog
approved these changes
Dec 15, 2025
sbawabe
deleted the
devin/1765559062-revamp-docs-starter-instructional
branch
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.
Summary
This PR transforms the docs-starter repository from placeholder "Plant Store API" demo content into instructional documentation that teaches users how to build their own docs with Fern.
New pages added:
Removed placeholder content:
Updated:
The Plant Store API spec (
openapi.yaml) is kept as the example API reference.Updates since last revision
Addressed additional PR feedback:
#70E155dark,#008700light) with white background (#FFFFFF)Review & Testing Checklist for Human
fern docs devand verify all pages render correctlyRecommended test plan: Run
fern docs dev, check that the logo and colors look correct, navigate through all pages, click the documentation links in the API reference table to verify they work, and confirm the Dashboard navbar button works.Notes
fern checkpassesLink to Devin run: https://app.devin.ai/sessions/c0ae31df1e1343e09404442d8cd302c4
Requested by: Sarah Bawabe (@sbawabe)