-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Update README with Promptless marketing and local dev instructions #231
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
Merged
prithvi2206
merged 1 commit into
main
from
promptless/update-readme-promptless-marketing
Jan 29, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,29 @@ | ||
| <br/> | ||
| <div align="center"> | ||
| <a href="https://www.buildwithfern.com/?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=logo"> | ||
| <img src="/fern/docs/assets/logo.svg" height="50" align="center" alt="header" /> | ||
| </a> | ||
|
|
||
| <br/> | ||
| # Promptless Docs | ||
|
|
||
| ### Docs Configuration | ||
| **https://docs.gopromptless.ai** | ||
|
|
||
| https://docs.gopromptless.ai | ||
| This documentation is written and maintained by [Promptless](https://promptless.ai), with edits and refinements by the Promptless team. Check out the [commit history](../../commits/main) to see Promptless drafting, updating, and refining documentation automatically based on product changes. | ||
|
|
||
| **Want Promptless to keep your docs up-to-date?** [Sign up at promptless.ai](https://promptless.ai) to get started. | ||
|
|
||
| </div> | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Node 18 or higher | ||
| - A [GitHub](https://github.com) account | ||
|
|
||
|
|
||
|
|
||
| ### Install the Fern CLI | ||
| --- | ||
|
|
||
| Install the Fern CLI globally by running: | ||
| ## Building These Docs Locally | ||
|
|
||
| ```bash | ||
| npm install -g fern-api | ||
| ``` | ||
| ### Prerequisites | ||
|
|
||
| The CLI commands in the following steps must be run from within the root folder of your repository. | ||
| - Node.js 18 or higher | ||
| - Fern CLI installed globally: | ||
| ```bash | ||
| npm install -g fern-api | ||
| ``` | ||
|
|
||
| ## Generate your documentation | ||
| ### Local Development | ||
|
|
||
| Run the following command: | ||
| From the repository root, run: | ||
|
|
||
| ```bash | ||
| fern generate --docs | ||
| ``` | ||
|
|
||
| You will be prompted to log in and connect your GitHub account. | ||
|
|
||
| Once the documentation is generated, you will receive the URL where your documentation is published. For example: | ||
|
|
||
| ```shell | ||
| ┌─ | ||
| │ ✓ plantstore.docs.buildwithfern.com | ||
| └─ | ||
|
|
||
| # OR | ||
|
|
||
| ┌─ | ||
| │ ✓ MY_ORGANIZATION_NAME.docs.buildwithfern.com | ||
| └─ | ||
| fern docs dev | ||
| ``` | ||
|
|
||
| ### Try local development | ||
|
|
||
| Preview your documentation locally. Run `fern docs dev` to access your docs on your local server at port 3000, hot-reloading as you edit your markdown and OpenAPI files. [Learn more](https://buildwithfern.com/learn/docs/getting-started/development?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step6) or [watch a 10-second demo](https://www.loom.com/share/0a4658bd78cb45d5a9519277852c7a24?sid=3ce69ad0-bfdb-4fa1-9abf-2f4366d084b9). | ||
|
|
||
| ### Customize your documentation | ||
|
|
||
| You must run `fern generate --docs` after any modifications to re-generate and publish your documentation site. | ||
|
|
||
| To preview updates to your documentation before publishing changes, run `fern generate --docs --preview`. | ||
|
|
||
| To use your own OpenAPI specification file or to update the existing one: | ||
|
|
||
| - Update or replace the OpenAPI specification file in the `openapi/` folder. | ||
| - _Note: Don't have an OpenAPI spec? Use Fern's simpler format to define your API._ [_Learn more_](https://github.com/fern-api/docs-starter-fern-definition?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7). | ||
|
|
||
| To modify the other docs pages: | ||
|
|
||
| - Update the Markdown files located in the `docs/pages/` folder, such as `welcome.mdx`. | ||
|
|
||
| To modify site styles and navigation, or to add new pages: | ||
|
|
||
| - See [Writing Content](https://buildwithfern.com/learn/docs/content/write-markdown?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7). | ||
|
|
||
| To learn about Fern's built-in component library you can use within MDX files: | ||
|
|
||
| - See the [Component Library](https://buildwithfern.com/learn/docs/content/components/overview?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7). | ||
|
|
||
| ### Set up a custom domain | ||
|
|
||
| If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.com` or a subpath like `https://YOUR_ORGANIZATION.com/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step8). Once subscribed, update `docs.yml` with the custom domain configuration: | ||
|
|
||
| ```yaml | ||
| - url: plantstore.docs.buildwithfern.com | ||
| custom-domain: plantstore.dev | ||
| ``` | ||
|
|
||
| ### Explore advanced features | ||
|
|
||
| For advanced documentation features and options, view the full [project structure](https://buildwithfern.com/learn/docs/getting-started/project-structure?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step9). | ||
|
|
||
| Good luck creating beautiful and functional documentation! 🌿 | ||
|
|
||
|
|
||
| ## Customer Showcase | ||
|
|
||
| Get inspired by API documentation built with Fern: [Hume](https://dev.hume.ai) | [Webflow](https://developers.webflow.com) | [Cartesia](https://docs.cartesia.ai) | [Cohere](https://docs.cohere.com) | [ElevenLabs](https://elevenlabs.io/docs) | ||
|
|
||
| --- | ||
| ## Support | ||
|
|
||
| Need help? [Set up a call](https://buildwithfern.com/contact?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=support) with an expert or email us at [support@buildwithfern.com](mailto:support@buildwithfern.com). | ||
| This starts a local server at `http://localhost:3000` with hot-reloading as you edit markdown and configuration files. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Citation: Prithvi's request to remove Fern marketing, add Promptless marketing info (docs written by Promptless, commit history link, sign-up CTA), and add "Building these docs locally" section with
fern docs devinstructions.View source