From 80f2022dcd11d261845ac05784f77791fd85323d Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 14 Aug 2025 05:49:13 +0000 Subject: [PATCH] Documentation updates from Promptless --- fern/docs/integrations/index.mdx | 1 + fern/docs/integrations/readme.mdx | 49 +++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 fern/docs/integrations/readme.mdx diff --git a/fern/docs/integrations/index.mdx b/fern/docs/integrations/index.mdx index 6ae0414..494dc7e 100644 --- a/fern/docs/integrations/index.mdx +++ b/fern/docs/integrations/index.mdx @@ -17,6 +17,7 @@ Some integrations can be used for multiple purposes. Some integrations are in a - [Jira](/docs/integrations/jira-integration): Look up relevant Jira issues and project data using JQL search capabilities when being triggered - [Linear](/docs/integrations/linear-integration): Look up relevant Linear issues and projects within a team when being triggered - [Microsoft Teams](/docs/integrations/microsoft-teams-integration): Trigger based on mentions and message actions in Microsoft Teams +- [ReadMe](/docs/integrations/readme-integration): Publish documentation updates directly to ReadMe-hosted documentation platform via API integration - [Slack](/docs/integrations/slack-integration): Trigger based on DMs or message actions in Slack - [Zendesk](/docs/integrations/zendesk-integration): Trigger based on resolved support tickets, and publish to Zendesk help center diff --git a/fern/docs/integrations/readme.mdx b/fern/docs/integrations/readme.mdx new file mode 100644 index 0000000..fd024b0 --- /dev/null +++ b/fern/docs/integrations/readme.mdx @@ -0,0 +1,49 @@ +# ReadMe Integration + +**Used for: Publishing** + +Promptless integrates with ReadMe through their native API to enable direct publishing of documentation updates to your ReadMe-hosted documentation platform. + + +**ReadMe Refactored Users**: If you're using ReadMe Refactored (which syncs with GitHub), you should use the [GitHub Integration](/docs/integrations/github-integration) instead of the native ReadMe API integration. The ReadMe Refactored API key will not work for the native API sync outlined in the rest of this doc. + + +## Installation + +1. Click "Connect ReadMe" from the [integrations page](https://app.gopromptless.ai/integrations). + +2. Enter your ReadMe API key and project subdomain when prompted. + + + ReadMe API Connection Form + + +3. Verify that ReadMe is connected in the integrations page. + +## Project Setup and Permissions + +After connecting ReadMe, you can configure publishing settings in the [projects page](https://app.gopromptless.ai/projects). When setting up a project, you can: + + +**Note**: ReadMe will only appear as an option in the docs location dropdown if you have successfully connected the ReadMe integration. If you don't see ReadMe listed, please ensure your integration is properly configured on the [integrations page](https://app.gopromptless.ai/integrations). + + + + ReadMe shown in docs location dropdown + + +- Set up ReadMe as a publishing destination for documentation updates +- Configure which files and sections should be published to ReadMe +- Use per-file publishing to update individual documentation pages + +### Configuration Options + +#### Include docs marked as hidden +- **Enabled**: Promptless can read from and publish to all pages, including those marked as hidden in ReadMe +- **Disabled**: Promptless will only interact with publicly visible pages in your ReadMe project + +This option is useful if you have draft content or internal documentation pages that you want to manage through Promptless but keep hidden from your public documentation. + +## Per-File Publishing + +ReadMe integration supports per-file publishing capabilities, allowing you to update individual documentation pages instead of requiring all files to be published at once.