From ea537e1acb51de2c27a2d71c6c3f221810c8c5c2 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Tue, 20 May 2025 20:07:30 +0000 Subject: [PATCH] Documentation updates from Promptless --- docs/changelogs/2025-05.md | 14 ++++++++ docs/core-concepts/doc-locations.md | 1 + docs/integrations/document360.md | 55 +++++++++++++++++++++++++++++ docs/integrations/index.mdx | 1 + 4 files changed, 71 insertions(+) create mode 100644 docs/changelogs/2025-05.md create mode 100644 docs/integrations/document360.md diff --git a/docs/changelogs/2025-05.md b/docs/changelogs/2025-05.md new file mode 100644 index 0000000..a11b6d2 --- /dev/null +++ b/docs/changelogs/2025-05.md @@ -0,0 +1,14 @@ +--- +sidebar_position: 0 +title: May 2025 +--- + +### May 19, 2025 + +**What's New:** + +* **Document360 HTML Support:** Promptless now supports HTML content in Document360 articles. This enhancement allows you to work with both Markdown and HTML-formatted articles in your Document360 knowledge base, with proper file extensions (.md for Markdown, .html for HTML) and optimized formatting. + +**Integrations:** + +* **Document360 Integration Documentation:** Added comprehensive documentation for the Document360 integration, including setup instructions and best practices for managing your knowledge base content. \ No newline at end of file diff --git a/docs/core-concepts/doc-locations.md b/docs/core-concepts/doc-locations.md index bef0a35..0d2c586 100644 --- a/docs/core-concepts/doc-locations.md +++ b/docs/core-concepts/doc-locations.md @@ -11,5 +11,6 @@ We also offer beta support for additional CMS platforms including: - Intercom - Pylon - Webflow +- Document360 Promptless is flexible and can integrate with any CMS platform that provides an API. If you're using a different CMS and would like to integrate it with Promptless, please contact us at hello@gopromptless.ai to discuss adding support for your CMS platform. \ No newline at end of file diff --git a/docs/integrations/document360.md b/docs/integrations/document360.md new file mode 100644 index 0000000..8045f6c --- /dev/null +++ b/docs/integrations/document360.md @@ -0,0 +1,55 @@ +--- +sidebar_position: 7 +--- + +# Document360 Integration + +Promptless integrates with Document360 to help you manage and update your knowledge base content automatically. This integration allows you to sync your Document360 articles with Promptless, enabling automated documentation updates based on your triggers. + +## Features + +- **Markdown and HTML Support**: Promptless supports both Markdown and HTML content from Document360 articles +- **Category Structure Preservation**: Maintains your Document360 category hierarchy +- **Metadata Retention**: Preserves important article metadata including titles, IDs, and URLs + +## Setup + +To set up the Document360 integration: + +1. Contact us at hello@gopromptless.ai to enable the Document360 integration for your account +2. Configure your Document360 API credentials in the Promptless dashboard +3. Select Document360 as your documentation platform when creating a new project + +## Content Format Support + +Promptless supports two content formats from Document360: + +### Markdown Content + +For articles authored in Markdown, Promptless will: +- Preserve the original Markdown formatting +- Store files with `.md` extension +- Maintain all links and embedded content + +### HTML Content + +For articles authored in HTML, Promptless will: +- Process and prettify the HTML structure for better readability +- Store files with `.html` extension +- Preserve all HTML elements and attributes + +## Publishing Updates to Document360 + +When you're ready to publish documentation updates to Document360: + +1. Review your changes in the Change History page +2. Click the "Save All & Update Document360" button +3. Promptless will create or update articles in your Document360 knowledge base + +## Best Practices + +- **Consistent Formatting**: For best results, try to use consistent formatting (either Markdown or HTML) across similar types of content +- **Category Organization**: Organize your Document360 categories logically to make it easier for Promptless to place new content appropriately +- **Regular Syncing**: Periodically sync your Document360 content with Promptless to ensure all updates are captured + +For any questions or issues with the Document360 integration, please contact our support team at help@gopromptless.ai. \ No newline at end of file diff --git a/docs/integrations/index.mdx b/docs/integrations/index.mdx index 3f0c54a..939a1a5 100644 --- a/docs/integrations/index.mdx +++ b/docs/integrations/index.mdx @@ -19,6 +19,7 @@ Some integrations can be used for multiple purposes. Some integrations are in a - [Slack](./slack): Trigger based on DMs or message actions in Slack - [Zendesk](./zendesk): Trigger based on resolved support tickets, and publish to Zendesk help center - [Linear](./linear): Look up relevant Linear issues and projects within a team when being triggered +- [Document360](./document360): Publish and update knowledge base articles in Document360 ## Security & Authentication