diff --git a/astro.config.mjs b/astro.config.mjs index 1c75488..9c84579 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -29,11 +29,6 @@ const redirects = { export default defineConfig({ site: process.env.SITE_URL || 'https://promptless.ai', redirects, - image: { - service: { - entrypoint: 'astro/assets/services/noop', - }, - }, integrations: [ react(), starlight({ @@ -65,6 +60,16 @@ export default defineConfig({ baseUrl: 'https://github.com/Promptless/docs/tree/main', }, head: [ + { + tag: 'link', + attrs: { + rel: 'preload', + href: '/fonts/InterVariable.woff2', + as: 'font', + type: 'font/woff2', + crossorigin: '', + }, + }, { tag: 'meta', attrs: { property: 'og:image', content: 'https://promptless.ai/assets/social-card.png' }, diff --git a/migration/redirects.generated.json b/migration/redirects.generated.json index e033bfe..50041ff 100644 --- a/migration/redirects.generated.json +++ b/migration/redirects.generated.json @@ -60,6 +60,11 @@ "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", "permanent": true }, + { + "source": "/docs/configuring-promptless/doc-collections/webflow-beta", + "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "permanent": true + }, { "source": "/docs/configuring-promptless/doc-collections/zendesk", "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", @@ -125,6 +130,16 @@ "destination": "/docs/integrations/intercom-integration-beta", "permanent": true }, + { + "source": "/docs/integrations/git-hub-integration", + "destination": "/docs/integrations/github-integration", + "permanent": true + }, + { + "source": "/docs/integrations/jira-integration", + "destination": "/docs/integrations/atlassian-integration", + "permanent": true + }, { "source": "/docs/integrations/microsoft-teams", "destination": "/docs/integrations/microsoft-teams-integration", diff --git a/package-lock.json b/package-lock.json index a501336..c0819ab 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,7 +26,7 @@ "@types/js-yaml": "^4.0.9", "@types/node": "^22.13.10", "tsx": "^4.19.3", - "typescript": "^5.8.2" + "typescript": "^5.9.3" }, "engines": { "node": ">=20.0" @@ -385,6 +385,7 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.29.0", "@babel/generator": "^7.29.0", @@ -1732,7 +1733,6 @@ "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", "optional": true, - "peer": true, "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.25" @@ -2610,6 +2610,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -2631,6 +2632,7 @@ "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -2743,6 +2745,7 @@ "resolved": "https://registry.npmjs.org/astro/-/astro-5.17.2.tgz", "integrity": "sha512-7jnMqGo53hOQNwo1N/wqeOvUp8wwW/p+DeerSjSkHNx8L/1mhy6P7rVo7EhdmF8DpKqw0tl/B5Fx1WcIzg1ysA==", "license": "MIT", + "peer": true, "dependencies": { "@astrojs/compiler": "^2.13.0", "@astrojs/internal-helpers": "0.7.5", @@ -3345,6 +3348,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -3363,8 +3367,7 @@ "version": "1.1.2", "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", - "optional": true, - "peer": true + "optional": true }, "node_modules/caniuse-lite": { "version": "1.0.30001770", @@ -3633,8 +3636,7 @@ "version": "3.2.3", "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/debug": { "version": "4.4.3", @@ -4787,16 +4789,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/jiti": { - "version": "1.21.7", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.7.tgz", - "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", - "optional": true, - "peer": true, - "bin": { - "jiti": "bin/jiti.js" - } - }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -7163,6 +7155,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -7215,6 +7208,7 @@ "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==", "dev": true, "license": "MIT", + "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -7266,6 +7260,7 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz", "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -7275,6 +7270,7 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz", "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==", "license": "MIT", + "peer": true, "dependencies": { "scheduler": "^0.27.0" }, @@ -7701,6 +7697,7 @@ "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.57.1.tgz", "integrity": "sha512-oQL6lgK3e2QZeQ7gcgIkS2YZPg5slw37hYufJ3edKlfQSGGm8ICoxswK15ntSzF/a8+h7ekRy7k7oWc3BQ7y8A==", "license": "MIT", + "peer": true, "dependencies": { "@types/estree": "1.0.8" }, @@ -7875,7 +7872,6 @@ "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", "optional": true, - "peer": true, "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" @@ -7886,7 +7882,6 @@ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "optional": true, - "peer": true, "engines": { "node": ">=0.10.0" } @@ -7970,7 +7965,6 @@ "resolved": "https://registry.npmjs.org/terser/-/terser-5.37.0.tgz", "integrity": "sha512-B8wRRkmre4ERucLM/uXx4MOV5cbnOlVAqUst+1+iLKPI0dOgFO28f84ptoQt9HEI537PMzfYa/d+GEPKTRXmYA==", "optional": true, - "peer": true, "dependencies": { "@jridgewell/source-map": "^0.3.3", "acorn": "^8.8.2", @@ -7988,8 +7982,7 @@ "version": "2.20.3", "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "optional": true, - "peer": true + "optional": true }, "node_modules/tiny-inflate": { "version": "1.0.3", @@ -8044,6 +8037,7 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -8101,6 +8095,7 @@ "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", "devOptional": true, "license": "MIT", + "peer": true, "dependencies": { "esbuild": "~0.27.0", "get-tsconfig": "^4.7.5" @@ -8127,6 +8122,7 @@ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -8427,6 +8423,7 @@ "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.1.tgz", "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", "license": "MIT", + "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.4", @@ -8975,6 +8972,7 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -9301,6 +9299,7 @@ "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", "devOptional": true, "license": "ISC", + "peer": true, "bin": { "yaml": "bin.mjs" }, @@ -9426,6 +9425,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/package.json b/package.json index e9c34cf..87c0fe9 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "@types/js-yaml": "^4.0.9", "@types/node": "^22.13.10", "tsx": "^4.19.3", - "typescript": "^5.8.2" + "typescript": "^5.9.3" }, "engines": { "node": ">=20.0" diff --git a/public/assets/Frame 29 (10).png b/src/assets/homepage/Frame 29 (10).png similarity index 100% rename from public/assets/Frame 29 (10).png rename to src/assets/homepage/Frame 29 (10).png diff --git a/public/assets/Frame 35.png b/src/assets/homepage/Frame 35.png similarity index 100% rename from public/assets/Frame 35.png rename to src/assets/homepage/Frame 35.png diff --git a/public/assets/promptless-2-2.png b/src/assets/homepage/promptless-2-2.png similarity index 100% rename from public/assets/promptless-2-2.png rename to src/assets/homepage/promptless-2-2.png diff --git a/public/assets/promptless_1_listen.png b/src/assets/homepage/promptless_1_listen.png similarity index 100% rename from public/assets/promptless_1_listen.png rename to src/assets/homepage/promptless_1_listen.png diff --git a/public/site/aaron.jpeg b/src/assets/site/aaron.jpeg similarity index 100% rename from public/site/aaron.jpeg rename to src/assets/site/aaron.jpeg diff --git a/public/site/alan.jpeg b/src/assets/site/alan.jpeg similarity index 100% rename from public/site/alan.jpeg rename to src/assets/site/alan.jpeg diff --git a/public/site/eduardo.jpeg b/src/assets/site/eduardo.jpeg similarity index 100% rename from public/site/eduardo.jpeg rename to src/assets/site/eduardo.jpeg diff --git a/public/site/logos/doc-detective.png b/src/assets/site/logos/doc-detective.png similarity index 100% rename from public/site/logos/doc-detective.png rename to src/assets/site/logos/doc-detective.png diff --git a/public/site/manny.jpeg b/src/assets/site/manny.jpeg similarity index 100% rename from public/site/manny.jpeg rename to src/assets/site/manny.jpeg diff --git a/public/site/mo.jpeg b/src/assets/site/mo.jpeg similarity index 100% rename from public/site/mo.jpeg rename to src/assets/site/mo.jpeg diff --git a/public/site/nicholas.jpeg b/src/assets/site/nicholas.jpeg similarity index 100% rename from public/site/nicholas.jpeg rename to src/assets/site/nicholas.jpeg diff --git a/public/site/step_3.png b/src/assets/site/step_3.png similarity index 100% rename from public/site/step_3.png rename to src/assets/site/step_3.png diff --git a/public/site/yc_logo.svg.png b/src/assets/site/yc_logo.svg.png similarity index 100% rename from public/site/yc_logo.svg.png rename to src/assets/site/yc_logo.svg.png diff --git a/src/components/site/Hero.astro b/src/components/site/Hero.astro index cbb2204..e61ad9a 100644 --- a/src/components/site/Hero.astro +++ b/src/components/site/Hero.astro @@ -1,4 +1,7 @@ --- +import { Image } from 'astro:assets'; +import ycLogo from '../../assets/site/yc_logo.svg.png'; + interface Props { prefix?: string; words?: string[]; @@ -38,7 +41,7 @@ const {
- Y Combinator + Y Combinator Backed by Y Combinator
Trusted by fast-growing startups and Fortune 500 enterprises alike diff --git a/src/components/site/HowItWorks.astro b/src/components/site/HowItWorks.astro index 33e66c0..3a78362 100644 --- a/src/components/site/HowItWorks.astro +++ b/src/components/site/HowItWorks.astro @@ -1,11 +1,20 @@ --- +import { Image } from 'astro:assets'; +import type { ImageMetadata } from 'astro'; + +import listenImg from '../../assets/homepage/promptless_1_listen.png'; +import draftImg from '../../assets/homepage/Frame 29 (10).png'; +import draftSecondaryImg from '../../assets/homepage/promptless-2-2.png'; +import reviewImg from '../../assets/site/step_3.png'; +import publishImg from '../../assets/homepage/Frame 35.png'; + interface Step { id: string; label: string; description: string; - image?: string; + image?: ImageMetadata; imageAlt?: string; - imageSecondary?: string; + imageSecondary?: ImageMetadata; imageSecondaryAlt?: string; } @@ -22,30 +31,30 @@ const defaultSteps: Step[] = [ id: 'listen', label: 'Listen', description: 'When a PR opens, a slack thread about docs starts, or a DOC ticket gets created, Promptless automatically wakes up and decides whether it warrants a doc update', - image: '/assets/promptless_1_listen.png', + image: listenImg, imageAlt: 'Step 1: Listen - Connect to Github, Slack, and Linear', }, { id: 'draft', label: 'Draft', description: 'Promptless does research across the context you connect it to, and proactively notifies you when there\'s a documentation suggestion.', - image: '/assets/Frame%2029%20(10).png', + image: draftImg, imageAlt: 'Step 2: Draft - Promptless notifies you proactively with suggestions', - imageSecondary: '/assets/promptless-2-2.png', + imageSecondary: draftSecondaryImg, imageSecondaryAlt: 'Step 2: additional Promptless draft screenshot', }, { id: 'review', label: 'Review', description: 'Review citations, provide feedback, or edit suggestions inline.', - image: '/site/step_3.png', + image: reviewImg, imageAlt: 'Step 3: Review - review citations, feedback, and inline edits', }, { id: 'publish', label: 'Publish', description: 'Open PRs or deploy directly to your docs provider.', - image: '/assets/Frame%2035.png', + image: publishImg, imageAlt: 'Step 4: Publish - open PRs or deploy directly to your docs provider', }, ]; @@ -72,11 +81,11 @@ const { {step.image ? ( <>
- {step.imageAlt + {step.imageAlt
{step.imageSecondary ? (
- {step.imageSecondaryAlt + {step.imageSecondaryAlt
) : null} diff --git a/src/components/site/Testimonials.astro b/src/components/site/Testimonials.astro index 46f62dc..3b79c40 100644 --- a/src/components/site/Testimonials.astro +++ b/src/components/site/Testimonials.astro @@ -1,11 +1,22 @@ --- +import { Image } from 'astro:assets'; +import type { ImageMetadata } from 'astro'; + +import mannyImg from '../../assets/site/manny.jpeg'; +import alanImg from '../../assets/site/alan.jpeg'; +import moImg from '../../assets/site/mo.jpeg'; +import aaronImg from '../../assets/site/aaron.jpeg'; +import eduardoImg from '../../assets/site/eduardo.jpeg'; +import nicholasImg from '../../assets/site/nicholas.jpeg'; +import docDetectiveLogo from '../../assets/site/logos/doc-detective.png'; + interface Testimonial { quote: string; author: string; title: string; company: string; - companyLogo: string; - image: string; + companyLogo: ImageMetadata | string; + image: ImageMetadata; } interface Props { @@ -19,8 +30,8 @@ const defaultItems: Testimonial[] = [ author: 'Manny Silva', title: 'Creator', company: 'Doc Detective', - companyLogo: '/site/logos/doc-detective.png', - image: '/site/manny.jpeg', + companyLogo: docDetectiveLogo, + image: mannyImg, }, { quote: @@ -29,7 +40,7 @@ const defaultItems: Testimonial[] = [ title: 'Docs Maintainer', company: 'Bazel', companyLogo: '/site/logos/bazel-icon.png', - image: '/site/alan.jpeg', + image: alanImg, }, { quote: @@ -38,7 +49,7 @@ const defaultItems: Testimonial[] = [ title: 'Senior Technical Writer', company: 'Runpod', companyLogo: '/site/logos/runpod.png', - image: '/site/mo.jpeg', + image: moImg, }, { quote: @@ -47,7 +58,7 @@ const defaultItems: Testimonial[] = [ title: 'Founding Solutions Engineer', company: 'Vellum', companyLogo: '/site/logos/vellum-icon.svg', - image: '/site/aaron.jpeg', + image: aaronImg, }, { quote: 'I love your product. It works incredibly well and basically pays for itself right away.', @@ -55,7 +66,7 @@ const defaultItems: Testimonial[] = [ title: 'CTO', company: 'Latitude.sh', companyLogo: '/site/logos/latitude.svg', - image: '/site/eduardo.jpeg', + image: eduardoImg, }, { quote: "Promptless is a solo tech writer's godsend.", @@ -63,7 +74,7 @@ const defaultItems: Testimonial[] = [ title: 'Head of Developer Docs', company: 'Prove', companyLogo: '/site/logos/prove-icon.svg', - image: '/site/nicholas.jpeg', + image: nicholasImg, }, ]; @@ -79,7 +90,7 @@ const { items = defaultItems } = Astro.props;

{item.quote}

diff --git a/src/content/docs/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code.mdx b/src/content/docs/docs/configuring-promptless/doc-collections/github-repos-docs-as-code.mdx similarity index 95% rename from src/content/docs/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code.mdx rename to src/content/docs/docs/configuring-promptless/doc-collections/github-repos-docs-as-code.mdx index 59ab3a9..66cd301 100644 --- a/src/content/docs/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code.mdx +++ b/src/content/docs/docs/configuring-promptless/doc-collections/github-repos-docs-as-code.mdx @@ -1,6 +1,6 @@ --- title: GitHub Repos (Docs as Code) -slug: docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code +slug: docs/configuring-promptless/doc-collections/github-repos-docs-as-code sidebar: hidden: false order: 20 @@ -59,7 +59,7 @@ When auto-publish is enabled for your project: - Promptless automatically creates a new PR in your documentation repository with suggested changes - For GitHub PR triggers, the documentation PR is linked in a comment on the original code PR -- For [commit triggers](/docs/configuring-promptless/triggers/git-hub-commits), you can enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) +- For [commit triggers](/docs/configuring-promptless/triggers/github-commits), you can enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) ## Automated CI Check and Build Issue Resolution diff --git a/src/content/docs/docs/configuring-promptless/triggers.mdx b/src/content/docs/docs/configuring-promptless/triggers.mdx index 518e77a..5a7d22f 100644 --- a/src/content/docs/docs/configuring-promptless/triggers.mdx +++ b/src/content/docs/docs/configuring-promptless/triggers.mdx @@ -14,11 +14,11 @@ Triggers are events that initiate automated documentation updates in Promptless. ## Available Trigger Types - + Automatically triggered when pull requests are opened in your GitHub repositories - + Monitor direct commits to default branches for documentation updates @@ -63,7 +63,7 @@ Need a trigger type that isn't currently supported? Contact us at [help@goprompt ## Auto-publish Mode -When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuring-promptless/triggers/git-hub-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created. +When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuring-promptless/triggers/github-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created. Auto-publish is available for all Git-hosted documentation platforms. diff --git a/src/content/docs/docs/configuring-promptless/triggers/git-hub-commits.mdx b/src/content/docs/docs/configuring-promptless/triggers/github-commits.mdx similarity index 98% rename from src/content/docs/docs/configuring-promptless/triggers/git-hub-commits.mdx rename to src/content/docs/docs/configuring-promptless/triggers/github-commits.mdx index 4cc4d7d..41d0be2 100644 --- a/src/content/docs/docs/configuring-promptless/triggers/git-hub-commits.mdx +++ b/src/content/docs/docs/configuring-promptless/triggers/github-commits.mdx @@ -1,6 +1,6 @@ --- title: GitHub Commits -slug: docs/configuring-promptless/triggers/git-hub-commits +slug: docs/configuring-promptless/triggers/github-commits sidebar: hidden: false order: 10 diff --git a/src/content/docs/docs/configuring-promptless/triggers/git-hub-p-rs.mdx b/src/content/docs/docs/configuring-promptless/triggers/github-prs.mdx similarity index 98% rename from src/content/docs/docs/configuring-promptless/triggers/git-hub-p-rs.mdx rename to src/content/docs/docs/configuring-promptless/triggers/github-prs.mdx index ca91f2f..137e00b 100644 --- a/src/content/docs/docs/configuring-promptless/triggers/git-hub-p-rs.mdx +++ b/src/content/docs/docs/configuring-promptless/triggers/github-prs.mdx @@ -1,6 +1,6 @@ --- title: GitHub PRs -slug: docs/configuring-promptless/triggers/git-hub-p-rs +slug: docs/configuring-promptless/triggers/github-prs sidebar: hidden: false order: 9 diff --git a/src/content/docs/docs/getting-started/core-concepts.mdx b/src/content/docs/docs/getting-started/core-concepts.mdx index 1246552..f6457ef 100644 --- a/src/content/docs/docs/getting-started/core-concepts.mdx +++ b/src/content/docs/docs/getting-started/core-concepts.mdx @@ -90,7 +90,7 @@ The diagram below illustrates how triggers, context sources, and documentation p

- Learn more in Configuring Promptless → GitHub Repos (Docs as Code). + Learn more in Configuring Promptless → GitHub Repos (Docs as Code).

diff --git a/src/content/docs/docs/getting-started/promptless-oss.mdx b/src/content/docs/docs/getting-started/promptless-oss.mdx index 470ccc5..f9a5e20 100644 --- a/src/content/docs/docs/getting-started/promptless-oss.mdx +++ b/src/content/docs/docs/getting-started/promptless-oss.mdx @@ -50,7 +50,7 @@ The basic setup for your open source project involves three steps: 2

Set Up Doc Collections

- Doc Collections tell Promptless where your + Doc Collections tell Promptless where your documentation lives.

@@ -60,7 +60,7 @@ The basic setup for your open source project involves three steps:

See - + GitHub Repos (Docs as Code) for setup instructions. @@ -94,7 +94,7 @@ The basic setup for your open source project involves three steps: ## Recommended Trigger Configuration -Most projects trigger Promptless on opened PRs. For popular open source projects—where many contributor PRs get closed without merging—consider using [GitHub Commit triggers](/docs/configuring-promptless/triggers/git-hub-commits) instead. This way, Promptless only runs when PRs are actually merged to your default branch. We recommend changing this setting after your initial calibration. +Most projects trigger Promptless on opened PRs. For popular open source projects—where many contributor PRs get closed without merging—consider using [GitHub Commit triggers](/docs/configuring-promptless/triggers/github-commits) instead. This way, Promptless only runs when PRs are actually merged to your default branch. We recommend changing this setting after your initial calibration. ## Additional Use Cases diff --git a/src/content/docs/docs/getting-started/welcome.mdx b/src/content/docs/docs/getting-started/welcome.mdx index 0fa3269..a6a918e 100644 --- a/src/content/docs/docs/getting-started/welcome.mdx +++ b/src/content/docs/docs/getting-started/welcome.mdx @@ -49,7 +49,7 @@ Promptless operates through three interconnected components that work together t Enrich docs with real-time access to your organization's knowledge through integrations with project management tools, code repositories, and team communications. - + Distribute updates across your entire docs ecosystem—from GitHub-synced platforms to help centers and content management systems. diff --git a/src/content/docs/docs/integrations/github-integration.mdx b/src/content/docs/docs/integrations/github-integration.mdx index 66eabd7..a18fcf5 100644 --- a/src/content/docs/docs/integrations/github-integration.mdx +++ b/src/content/docs/docs/integrations/github-integration.mdx @@ -85,7 +85,7 @@ Once connected, you can use GitHub for: - **[Triggers](/docs/configuring-promptless/triggers)**: Monitor pull requests and commits for documentation updates - **[Context Sources](/docs/configuring-promptless/context-sources)**: Search code repositories and issues for technical context -- **[Doc Collections](/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code)**: Publish documentation updates to GitHub-based platforms +- **[Doc Collections](/docs/configuring-promptless/doc-collections/github-repos-docs-as-code)**: Publish documentation updates to GitHub-based platforms ## Frequently Asked Questions diff --git a/src/lib/generated/sidebar.json b/src/lib/generated/sidebar.json index c8b02ed..6582687 100644 --- a/src/lib/generated/sidebar.json +++ b/src/lib/generated/sidebar.json @@ -40,11 +40,11 @@ }, { "label": "GitHub PRs", - "slug": "docs/configuring-promptless/triggers/git-hub-p-rs" + "slug": "docs/configuring-promptless/triggers/github-prs" }, { "label": "GitHub Commits", - "slug": "docs/configuring-promptless/triggers/git-hub-commits" + "slug": "docs/configuring-promptless/triggers/github-commits" }, { "label": "Slack Messages", @@ -94,7 +94,7 @@ }, { "label": "GitHub Repos (Docs as Code)", - "slug": "docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code" + "slug": "docs/configuring-promptless/doc-collections/github-repos-docs-as-code" } ] } diff --git a/vercel.json b/vercel.json index c60ce36..2856ff3 100644 --- a/vercel.json +++ b/vercel.json @@ -1,6 +1,28 @@ { "outputDirectory": "dist", "redirects": [ + { + "source": "/docs/:path*", + "has": [ + { + "type": "host", + "value": "docs.promptless.ai" + } + ], + "destination": "https://promptless.ai/docs/:path*", + "permanent": true + }, + { + "source": "/changelogs/:path*", + "has": [ + { + "type": "host", + "value": "docs.promptless.ai" + } + ], + "destination": "https://promptless.ai/changelog/:path*", + "permanent": true + }, { "source": "/:path*", "has": [ @@ -9,7 +31,29 @@ "value": "docs.promptless.ai" } ], - "destination": "https://promptless.ai/:path*", + "destination": "https://promptless.ai/docs/:path*", + "permanent": true + }, + { + "source": "/docs/:path*", + "has": [ + { + "type": "host", + "value": "docs.gopromptless.ai" + } + ], + "destination": "https://promptless.ai/docs/:path*", + "permanent": true + }, + { + "source": "/changelogs/:path*", + "has": [ + { + "type": "host", + "value": "docs.gopromptless.ai" + } + ], + "destination": "https://promptless.ai/changelog/:path*", "permanent": true }, { @@ -20,6 +64,17 @@ "value": "docs.gopromptless.ai" } ], + "destination": "https://promptless.ai/docs/:path*", + "permanent": true + }, + { + "source": "/:path*", + "has": [ + { + "type": "host", + "value": "gopromptless.ai" + } + ], "destination": "https://promptless.ai/:path*", "permanent": true }, @@ -125,37 +180,42 @@ }, { "source": "/docs/configuration/doc-collections", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuration/doc-collections/github-repos", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuration/doc-collections/intercom", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuration/doc-collections/zendesk", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuring-promptless/doc-collections", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuring-promptless/doc-collections/intercom-beta", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", + "permanent": true + }, + { + "source": "/docs/configuring-promptless/doc-collections/webflow-beta", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/configuring-promptless/doc-collections/zendesk", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { @@ -165,12 +225,12 @@ }, { "source": "/docs/configuration/triggers/github-commits", - "destination": "/docs/configuring-promptless/triggers/git-hub-commits", + "destination": "/docs/configuring-promptless/triggers/github-commits", "permanent": true }, { "source": "/docs/configuration/triggers/github-prs", - "destination": "/docs/configuring-promptless/triggers/git-hub-p-rs", + "destination": "/docs/configuring-promptless/triggers/github-prs", "permanent": true }, { @@ -200,12 +260,12 @@ }, { "source": "/docs/doc-collections", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { "source": "/docs/doc-collections/git-hub-repos-docs-as-code", - "destination": "/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code", + "destination": "/docs/configuring-promptless/doc-collections/github-repos-docs-as-code", "permanent": true }, { @@ -218,6 +278,16 @@ "destination": "/docs/integrations/intercom-integration-beta", "permanent": true }, + { + "source": "/docs/integrations/git-hub-integration", + "destination": "/docs/integrations/github-integration", + "permanent": true + }, + { + "source": "/docs/integrations/jira-integration", + "destination": "/docs/integrations/atlassian-integration", + "permanent": true + }, { "source": "/docs/integrations/microsoft-teams", "destination": "/docs/integrations/microsoft-teams-integration", @@ -235,7 +305,7 @@ }, { "source": "/docs/triggers/git-hub-commits", - "destination": "/docs/configuring-promptless/triggers/git-hub-commits", + "destination": "/docs/configuring-promptless/triggers/github-commits", "permanent": true }, {