Skip to content

docs: Lint page structure with manni, restructure every docs page by type, and embed integration procedures as partials - #1177

Merged
hawkeyexl merged 35 commits into
mainfrom
promptless/manni-lint-structure
Oct 20, 2026
Merged

hawkeyexl merged 35 commits into
mainfrom
promptless/manni-lint-structure

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Proposed changes

Pages now carry a doc type in their type: frontmatter. This PR checks each page's structure against the template for its type, using manni lint structure. It restructures and edits every docs page so all 132 pass: fifteen of the worst-failing pages in three passes of five, then the remaining 117 in one pass, with each page's type re-assessed. Review passes retype five pages as how-to guides and move every integration's connection procedure into shared MDX partials. The PR pins manni 4.13.0.

Lint integration

  • manni.config.yaml gets a lint: section. Pages route by type: to manni's built-in Good Docs Project templates (tgdp:*:1.6). The four types the site uses that manni has no template for are mapped: installation-guide and quickstart to how-to, and glossary and contact-support to reference.
  • manni.yml gets a structure job. On a PR it lints only the docs pages the PR adds or changes, and annotates them inline. On main it lints every page. Both steps are advisory (continue-on-error), so the job never blocks a merge. The existing validate job is unchanged.
  • npm run lint:structure runs the lint locally. AGENTS.md documents it and notes that npx manni check now includes the structure job. ADR 0006 records the decision.

Baseline (measured with manni 4.12.2): with this config, 131 of 132 pages fail on main, with 415 findings. Most findings are reference H2 sections with no table (the TGDP reference template wants a table in every entry section after the first) and concept pages with no Use cases section. With this PR, all 132 pages pass, with 0 findings. To make structure findings block PRs, remove continue-on-error from the PR step.

First pass (5 pages). These are the pages with the most findings, apart from ones that already had three or more open suggestions editing them.

  • reference/integrations/github-enterprise.mdx (11 findings): retyped from reference to how-to, because the page is a nine-step procedure. It gains Overview, Before you start, and See also sections. Permissions and webhook events are now tables, replacing four per-permission screenshots. Hostname requirements move into the prerequisites. "Whitelist" becomes "allow list".
  • connect/triggers/github-commits.mdx (7): reference tables for use cases, commit vs. PR triggers, match-clause fields, and publishing options. The #auto-merge-mode anchor is kept.
  • connect/triggers/slack-messages.mdx (7): tables for trigger methods, attachments, reply modes, channel types, and what Promptless reads. The duplicate Configuration section is merged into Passive channel listening. The #thread-reply-trigger-mode anchor is kept.
  • governance/reference/pig-cli-reference.mdx (7): option tables for every command, and a cause table for failed commands. Fixes a stale fact: pig init --org is now required. It no longer defaults to Promptless (Require customer organization when initializing a hub pig-toolchain#93).
  • security/how-promptless-uses-ai.mdx (7): the data-handling, least-privilege, and enterprise points are now scannable tables, each with its source link.

last-updated is restamped with npx manni meta derive --fields last-updated on only the edited pages.

Second pass (5 pages). These are the next-worst pages, and they include pages that other open suggestions also edit. Those suggestions need a rebase after this merges.

  • governance/start-here/key-concepts.mdx (12 findings): the 15 one-term sections are now four groups (hub content; builds, releases, and updates; hosts and trace collection; analysis and remediation). Each group opens with a Term and Definition table. Details and examples sit in H3s that keep the old heading anchors.
  • connect/triggers/github-prs.mdx (12): tables for trigger modes, match-clause fields, which PRs trigger a review, publishing options, and where an @promptless mention works. The redundant "How it works" overview is removed. Fixes stale facts: trigger_on is required (opened was labeled the default), the topics filter's current dashboard label, and draft PRs, where a mention in the title or description still starts work.
  • connect/doc-locations/github-repos.mdx (12): 12 thin sections become 7, with tables for supported platforms, doc collection settings, path scope, PR publishing behaviors, Slack link labels, and FAQ. Fixes stale facts: admins can edit doc collection settings, including the repository, in the dashboard. The page also gets the repository picker's current empty message, mdBook and Sphinx in the platform list, and auto-merge for PR-triggered docs PRs. #supported-platforms now exists, so two existing links to it resolve.
  • connect/triggers/gitlab-merge-requests.mdx (11): tables for match-clause fields (adds branches), webhook status colors, publishing options, and what a comment mention does. Fixes "opened or updated" to "opens or merges", the GitLab events a trigger acts on.
  • reference/integrations/gitlab.mdx (9): tables for capabilities by host, token requirements, webhook events, and FAQ. Fixes the trigger events, the Refresh access control name, and the stale directory-trigger steps. It also removes a claim that webhooks can be customized.

The second pass keeps every heading that other pages link to, except #supported-docs-platforms (no inbound links).

Third pass: five pages retyped as how-to guides (review feedback). Per review, connect/triggers/github-commits.mdx, github-prs.mdx, gitlab-merge-requests.mdx, slack-messages.mdx, and reference/integrations/gitlab.mdx change from type: reference to type: how-to. Each now follows the TGDP how-to template, like github-enterprise.mdx: Overview, Before you start, task sections with verb headings, and See also. The trigger pages' reference tag becomes guide, matching jira-automation.mdx. All five pass manni lint structure.

  • Trigger pages: each gets an "Add a … trigger" procedure (open the Configuration page in YAML mode, add the trigger, save), followed by tasks for scoping and publishing. Before you start lists the connected integration and the Promptless admin role that editing the configuration needs.
  • slack-messages.mdx: tasks for requesting docs from a thread, replying in a thread Promptless is in, changing the thread reply trigger mode, and setting up passive channel listening.
  • gitlab.mdx: token requirements and token scope considerations move into Before you start. Installation becomes an eight-step "Connect a GitLab group" procedure. Merge request triggers, publishing, and the FAQ (now "Fix common connection problems") follow as tasks.
  • Renamed anchors, with every inbound link updated: github-commits#auto-merge-mode → #turn-on-auto-merge-mode, github-prs#trigger-modes → #choose-trigger-modes, #directory-specific-triggers → #limit-a-trigger-to-specific-directories, #repository-topics → #limit-a-trigger-to-tagged-repositories, gitlab-merge-requests#webhook-delivery-status → #check-webhook-delivery-status, #comment-mention-acknowledgment → #confirm-promptless-saw-your-mention, slack-messages#thread-reply-trigger-mode → #change-the-thread-reply-trigger-mode, and gitlab#source-code-reading → #overview. The links live in seven docs pages (restamped) and three changelog entries.

Fourth pass: integration procedures as shared partials (review feedback). The Reference > Integrations pages were mostly procedures, so each connection procedure now lives in one MDX partial and is embedded where readers need it. Partials use Starlight and Astro's standard mechanism: import an MDX file as a component. ADR 0007 records the decision.

Partial (src/partials/integrations/) Embedded in
github-connect.mdx GitHub PRs, GitHub commits, GitHub issues, GitHub repos, GitHub integration
github-read-only-connect.mdx GitHub repos, GitHub (read-only) integration
gitlab-connect.mdx GitLab merge requests, GitLab projects, GitLab integration
slack-connect.mdx Slack messages, Slack integration
microsoft-teams-connect.mdx Review from Slack and Teams, Microsoft Teams integration
atlassian-connect.mdx Jira trigger, Jira Automation, Jira and Confluence context sources, Atlassian integration
linear-connect.mdx Linear context source, Linear integration
launchdarkly-connect.mdx LaunchDarkly trigger, LaunchDarkly integration
vercel-connect.mdx Starport connections, Vercel integration
  • Host pages get a verb-first "Connect …" section with the partial, and their prerequisites point to it. Partials carry no headings, because Astro leaves an imported file's headings out of the page TOC and manni can't see them.
  • The Reference > Integrations group is out of the sidebar. The pages stay published, searchable, and linkable from the homepage, search starter links, and other pages. sidebar.hidden would also have dropped them from search, the sitemap, and llms.txt. Each integration page embeds the same partial in place of its own steps.
  • The GitHub Enterprise nine-step procedure stays on its own page. Embedding it would add about 150 lines to a host page, and the GitHub partial links to it.
  • src/lib/mdx-partials.ts inlines partials for the two raw-source readers: the /<page>.md endpoint and the MCP get_page index (new transformContent option). tests/unit/mdx-partials.spec.ts covers it. @partials/* is aliased in tsconfig.json and the Vite config.
  • Renamed anchors with no inbound links: #installation on the integration pages, and #setup-instructions on the GitHub issues, GitLab projects, and context-source pages. One changelog link to slack#when-admin-approval-is-required now points to slack-messages#connect-slack.
  • CI: the search-quality test needs "slack setup" to rank the Slack messages page in the top 3. The third pass dropped the page's "setup" wording and failed verify. The page now includes the Slack setup steps and passes.

Fifth pass: no type: reference outside the reference sections (review feedback). 35 pages outside docs/for-docs/reference/ and docs/governance/reference/ change type. Only the type: line changes, except on the two pages below that this PR had already brought to passing.

  • how-to (26): the context-source pages (Confluence, Google Drive, Jira, Linear, Notion, Slite), GitHub repos, GitLab projects, the API, GitHub issues, Jira, LaunchDarkly, MCP, and Schedule triggers, Referral program, Environment variables, Single sign-on, Starport analytics, Configure Starport, Starport connections, the governance Compute and sizing, Model providers, Networking and identity, Object storage, and PostgreSQL pages, and Marketing images.
  • concept (9): Access and permissions, Compliance and certifications, Data handling and classification, How Promptless uses AI, Network architecture, Privacy policy, Secrets and sensitive data, What's included in Starport, and Trust and data model.
  • To keep passing under their new types, GitHub repos gets Overview, Connect, and See also sections, and How Promptless uses AI gets a Use cases section.
  • Still type: reference outside a reference section, because each is a lookup page: governance/deploy-the-worker/configuration-reference.mdx, governance/deploy-the-worker/manual-helm-reference.mdx, security/subprocessors.mdx, media-kit.mdx, and internal/component-fixtures.mdx. Each needs a decision: move it into a reference section (new URL and redirect) or keep it where it is.
  • No other open suggestion changes the type: line on these pages. 17 open suggestions edit 13 of them elsewhere, so the merges should be clean.

Sixth pass: remove the Linear Google sign-in screenshot (review feedback). public/assets/linear-auth.png showed a Promptless employee's email address and profile photo. This PR deletes it and removes it from linear-connect.mdx. The Linear sign-in screenshot (linear-signin.png) stays. PR #1180 removes the same image from main so it leaves the live site without waiting on this PR. If #1180 merges first, resolve the reference/integrations/linear.mdx conflict here by keeping this PR's version.

Merge from main (#1180). The merge commit keeps this PR's reference/integrations/linear.mdx, and manni 4.12.2 misreads a merge like that as an uncommitted body change, so validate failed. A follow-up commit touches the page and keeps last-updated: 2026-10-19, so manni traces the page's history correctly and validate passes.

Seventh pass: manni 4.13.0 and the next five pages (dashboard task).

  • @hawkeyexl/manni goes from 4.12.2 to 4.13.0. Each structure finding now names the template section it breaks and what that section is for, and npx manni lint templates show <template> lists every section with its purpose. AGENTS.md points authors to it. The upgrade doesn't change any counts: 250 findings across 120 pages before this pass. meta validate passes on all 132 pages.
  • The next five pages by findings, skipping the Reference > Integrations pages that the fourth pass took out of the sidebar. MCP triggers, which tied for next in line earlier, dropped from 9 findings to 2 after the fifth pass retyped it as a how-to.
    • for-docs/reference/configuration-reference.mdx (9 findings): every H2 now opens with a table: file sections, doc collection fields, filter entries, context source types, trigger fields, built-in triggers, policy sections, channel inheritance, rule matching, error-marker parts, common errors, and what a rename updates. "Example configuration" and "Migration from projects" become H3s and keep their anchors. Fixes: the context source example's google_drive: key is invalid (keys are kebab-case, so google-drive:); host is invalid only for github and github_oss; a repository rename also rewrites doc_collection in policy rules. Removed anchors with no inbound links: #fields, #available-sources, #repository-renames (now #repository-and-channel-renames).
    • governance/deploy-the-worker/observability.mdx (6): stays troubleshooting, now in the template's shape. The intro keeps the stage table (with a column linking each stage to its symptom), log commands, and data-preservation caution. Six Symptom sections follow, each with Cause and Solution. The Datadog and Sentry details move to the Helm reference, and this page links there. No inbound links pointed at the removed anchors.
    • governance/deploy-the-worker/manual-helm-reference.mdx (5): tables of key, default, and meaning for service account, database TLS, image, probes, Datadog, and Sentry values. Checked against the published 0.3.6 chart (Promptless/pig-deploy). Fixes: the service-account example set migrationJob.serviceAccountName, which the 0.3.6 schema rejects (both workloads use serviceAccount.name); load-balancer health checks point at /healthz, matching the deploy guides; adds the missing DD_TRACE_ANALYTICS_ENABLED. Anchors: #enable-datadog → #datadog-tracing-values (its one inbound link is updated), #enable-sentry → #sentry-error-reporting-values, #validate-a-configuration-change → #apply-a-configuration-change. The page keeps its path and type: reference.
    • for-docs/reference/account-management.mdx (5): stays reference. Tables for roles, admin-only configuration, enrollment modes, security features, Billing sections, and Current plan fields. Procedures are short numbered steps with the dashboard's current labels (checked against the pinned Clerk localization). "Need help?" becomes See also. Fixes: Manage opens the organization's management page, not a modal; the retired agent behavior settings are removed. #billing and its H3 anchors are unchanged.
    • for-docs/connect/connection-health.mdx (5): intro with the card health labels, six Symptom sections with Cause and Solution, and For more information. Fixes: the repository picker's empty message is "No connected repository matches that.", and the picker covers GitHub or GitLab; Promptless notifies the escalation channel, if one is set, when a connection needs reconnecting or stays degraded for 24 hours.
  • Open suggestions that also edit these pages: eight on the configuration reference, one each on observability (repository_sha), account management (free trial), and connection health (Jira service account). Whichever merges second needs a rebase.

Eighth pass: every remaining page, with each type re-assessed (dashboard task). The 117 pages that the earlier passes didn't restructure. Each now follows its type's template and has a clarity edit, and site-wide manni lint structure goes from 220 findings across 115 pages to 0 across 132. ADR 0006 is updated to match.

  • How-tos open with an Overview (the task, when, and why) and end with See also. Buried procedures become numbered steps with one action each. Concepts get a Use cases section that starts from a reader's problem. Reference sections become tables. The FAQs (for-docs/reference/faq.mdx, governance/reference/faq.mdx) become Question | Answer tables per topic, and the integration pages' <details> FAQs become problem, cause, and fix tables. Redundant passages, marketing tone, and "Need help?" footers are cut.
  • Type review. Each page's type was checked against its intent, its section's job in the IA, and the personas and journeys in docs.metadata.yaml. 12 pages change type, and 105 keep theirs:
    • reference → how-to: the eight remaining Reference > Integrations pages (Atlassian, GitHub, GitHub read-only, LaunchDarkly, Linear, Microsoft Teams, Slack, Vercel). Each is a connect-and-manage task, like the GitLab and GitHub Enterprise pages.
    • concept → reference: reference/integrations.mdx, a lookup in the Reference section. It's now tables of integrations and what each provides, health labels, notification timing, and card actions.
    • how-to → concept: connect/source-control.mdx (helps a reader choose a connection and scope its access; the steps live on the integration pages) and starport/agent-ready.mdx (describes what a Starport site ships; no task).
    • concept → how-to: governance/deploy-the-worker/plan-your-deployment.mdx (checking requirements, choosing a path, and registering an analyzer are setup tasks).
    • No page moves, and no slug changes. The five lookup pages outside a reference section stay type: reference in place until the placement question is answered.
  • Anchors. Headings that other pages, changelog entries, partials, or the product link to are kept, including every MCP tool heading. Renamed or removed headings had no inbound links, except microsoft-teams#reading-files-you-share → #choose-which-shared-files-promptless-can-read, whose one link (in the Teams partial) is updated.
  • Partials. Four integration partials are updated with the pages that embed them (Atlassian, GitHub, Microsoft Teams, Slack).
  • Stale facts fixed against the product source and the published pig-deploy and pig-toolchain repos (citations are on the PR):
    • Connect: the Google Drive example key is google-drive:. The Notion tools table is replaced (Promptless reads Notion through its CLI now). The Connect Notion, Connect Slite, and Connect Atlassian labels are current, and Slite connects with an API key, not OAuth. The GitLab project picker is pick-only. GitHub issue mentions work in the title, description, or a comment. The schedule trigger button is Add an automatic or scheduled trigger.
    • Integrations: the health label is Problem, not "Temporary outage", and a notice goes out after 24 hours. Slack drops files:write and diff files and adds files:read. Atlassian adds manage:jira-webhook and follows the current Jira identity rules: an attached service account does all Jira work, and without one Promptless writes as the connecting account only with explicit permission. Teams adds two permissions and the SharePoint site-grant steps. GitHub's owner-approval flow completes on its own after approval.
    • Review and tune: the close dialog's checkbox is Send to Promptless. The comment mode is Require a mention. A new PR trigger starts with both opened and merged selected. The Triggers page filter is Suggestion Activity, and its 100-item cap is gone. Deep Analysis templates set their own mode.
    • Start here, scale, and migrate: the quickstart's Connect chat step can't be skipped, and Connect docs accepts GitLab. Environment variables are admin-only, and key names are limited to uppercase letters, digits, and underscores. A deleted multi-repo policy field is replaced with the current rule editor labels. Migration pages accept GitLab as well as GitHub. Doc Detective and Vale config paths are set under More filters (optional).
    • Security: network architecture said data "at rest" where it meant in transit. GitLab source access isn't read-only, because connecting a group creates merge request webhooks. how-promptless-uses-ai.mdx now says GitLab has no read-only option.
    • Starport: llms.txt links to llms-full.txt and llms-small.txt. The assistant is labeled Ask Assistant. Deployed settings go in the hosting provider's environment, not .env. PostHog reporting needs a project key.
    • PIG: pig init --org is required. A deployed analyzer gets repository tokens from the Promptless GitHub App, not a configured token. PostgreSQL accepts only sslmode=verify-full, with a pool of up to eight connections. The manual Helm upgrade scales deployment/pig-trace-analyzer. GKE Standard needs a nodeSelector, now in the GCP guide and both references. The Azure and GCP Terraform input names are fixed.
  • Validation: manni lint structure passes all 132 pages, manni meta validate passes all 132 (after npx manni meta derive --fields last-updated on the changed pages), remark-lint is clean, and Vale reports no new or remaining errors on the changed files. Locally, the build, typecheck, markdown, MCP, search, search-quality, and smoke tests pass.
  • Other open suggestions edit many of these pages. Whichever merges second needs a rebase. Claims in suggestions 4dcd4c73 (GitLab token requirements) and a01ce65d (mention-only GitLab merge request comments) are left as they are.

Merge from main (#1172). PR #1172 (Jira service-account identity, write permission, and reply behavior) conflicted with five restructured pages. Merge commit e03d0f2 resolved them by keeping this PR's structure and carrying #1172's facts into it. A follow-up commit adds two #1172 changes that the merge had missed, on reference/integrations/atlassian.mdx and connect/triggers/jira.mdx:

Ninth pass: follow-ups on the points to check (dashboard task).

  • migrate/why-docs-as-code.mdx: FrameMaker works "through a MIF intermediary" (was "MIP").
  • Docs-as-code is no longer described as required. why-docs-as-code.mdx drops the "hard prerequisite" callout, and "Why Promptless requires it" becomes "How Promptless works with docs-as-code". The page's description, intent, and sample question match. choose-a-platform.mdx and migrate-to-a-new-platform.mdx drop the "Promptless needs" wording. All three now say Promptless also publishes to Heretto CCMS folders, as Heretto suggestions, which matches the heretto doc collection platform.
  • The retired Kubernetes Helm guide (security/self-hosting/kubernetes-helm.mdx, hidden) is deleted. Its four redirects (/self-hosting/kubernetes-helm, /docs/self-hosting/kubernetes-helm, /docs/security/self-hosting/kubernetes-helm, and the page's own URL) now go to the self-hosting overview. Its docs.metadata.yaml entry, frozen-route fixture rows, and sitemap test assertion are removed, and the route manifest is regenerated. The self-hosting overview (also hidden) loses the chart's description, its supported-platforms table, and the link card. A short "Deployment options" section says the Promptless team plans each deployment with you.
  • The integration health alerts blog post names the Problem label instead of "Temporary outage". The June 2026 changelog entry keeps the label name it shipped with.
  • The outdated New Task screenshot is removed from get-the-most-out/pay-down-docs-debt.mdx, and the docs-as-code page's Open Graph image is regenerated for its new description. The overall comments screenshot was already removed from work-the-queue/giving-feedback.mdx in the eighth pass.
  • Bitbucket: the eighth pass had added Bitbucket to the backfill section of connect/triggers.mdx and to the quickstart. Those mentions are removed, following docs: Remove Bitbucket from the docs #1034, which took Bitbucket out of the docs because it isn't wired up.
  • Validation: manni lint structure and manni meta validate pass all 131 pages. remark-lint is clean. Vale reports no collection errors on the changed files. Locally, npm run check passes on Node 24: typecheck, markdown, MCP, search, the build, and search quality.

Tenth pass: one "Overview" in "On this page", <Steps> for every procedure, and the MCP skill rename (dashboard task).

  • Doubled "Overview": Starlight always starts "On this page" with an entry for the top of the page, labeled "Overview". The how-to template's required ## Overview heading, now on 89 pages, added a second one. A Starlight route middleware (src/starlightRouteData.ts, logic in src/lib/toc-overview.ts, unit test in tests/unit/toc-overview.spec.ts run by test:markdown) drops the heading's entry when it repeats the top entry. The list shows "Overview" once, linking to the top of the page. Headings, anchors, and the structure lint are unchanged, and ADR 0006 records the tradeoff.
  • <Steps>: 141 numbered procedures on 67 pages are now wrapped in Starlight's <Steps>, with Steps added to each page's import. The integration partials already used <Steps>. Eight numbered lists describe what Promptless does rather than steps a reader takes, so they stay plain lists: the Doc Detective failure follow-up, Vale enforcement, trigger processing, the analytics and inbound-review workflow outcomes, the read-only fork flow, the GitLab merge request flow, and the three filtering points. Items inside <Steps> are separated by blank lines so Vale reads each step as its own paragraph. Five sentences that Vale then flagged as too long are split.
  • MCP: the workflow skill suggestion-triage is renamed triage-suggestions in connect/triggers/mcp.mdx (five places), following Promptless/promptless#5530. PR docs: Rename the MCP suggestion-triage skill to triage-suggestions #1182 makes the same change on main, so whichever merges second has a small mcp.mdx conflict. Keep triage-suggestions either way.

Checklist

  • Instructions and examples match the current product behavior.
  • Links and image references are valid.
  • Changed pages render correctly (local build, typecheck, markdown, MCP, search, search-quality, and smoke tests pass on Node 24).

Review feedback in this update

  • "This should be a how-to" (five threads: GitHub commits, GitHub PRs, GitLab merge requests, Slack messages, GitLab integration): applied. Each page is now type: how-to and passes manni lint structure. The GitLab integration page keeps the how-to shape, and its connection steps now come from the shared GitLab partial.

  • "Extract the integration procedures into shared snippets … and remove them from the TOC": applied, with two changes. The GitHub Enterprise procedure stays on its own page because of its size. The integration pages leave the nav but aren't sidebar.hidden, so they stay in search, the sitemap, and llms.txt.

  • "Make sure that nothing outside of the reference section is labelled as type: reference": applied to 35 pages. Five lookup pages keep type: reference until someone decides whether to move them into a reference section.

  • CI verify failure (search-quality test "slack setup"): fixed. A local npm run check passes.

  • "Remove the screenshot please" (dashboard task, about linear-auth.png): applied. The image and its reference in linear-connect.mdx are removed.

  • "Update to the newest version of manni … then start on the next highest priority pages" (dashboard task): applied. manni is pinned to 4.13.0, and the configuration reference, observability, manual Helm reference, account management, and connection health pages are restructured (seventh pass).

  • "Handle every other page in the doc set, additionally re-assessing each type …" (dashboard task): applied to the remaining 117 pages (eighth pass). All 132 pages now pass manni lint structure; 12 pages change type, none move.

  • "For points to check: … correct MIP to MIF; revise to remove references that docs as code is required; remove the unused chart; remove 'temporary outage', remove out-of-date screenshots" (dashboard task): applied (ninth pass). Points 1 and 2 (context source scope, Voice Match) and the other unverified items in point 3 are left as they are.

  • "Many pages have a doubled 'Overview' in the side nav. Figure out why and fix it." (dashboard task): applied (tenth pass).

  • "Procedures should consistently be using ." (dashboard task): applied to 141 procedures on 67 pages (tenth pass).

Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
promptless-docs Ready Ready Preview Oct 20, 2026 4:55pm UTC

Request Review

Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
Comment thread src/content/docs/docs/governance/reference/pig-cli-reference.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-commits.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-commits.mdx
Comment thread src/content/docs/docs/governance/start-here/key-concepts.mdx
Comment thread src/content/docs/docs/governance/start-here/key-concepts.mdx
Comment thread src/content/docs/docs/governance/start-here/key-concepts.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/gitlab-merge-requests.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/integrations/gitlab.mdx
Comment thread src/content/docs/docs/for-docs/reference/integrations/gitlab.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/integrations/gitlab.mdx Outdated
Comment thread src/content/docs/docs/for-docs/get-the-most-out/localization.mdx
Comment thread src/content/docs/docs/for-docs/get-the-most-out/release-notes.mdx
Comment thread src/content/docs/docs/for-docs/get-the-most-out/screenshots.mdx
Comment thread src/content/docs/docs/for-docs/tune/notifications.mdx
Comment thread src/content/docs/docs/for-docs/tune/release-timing.mdx
Comment thread src/content/docs/docs/for-docs/tune/teaching-conventions.mdx
Comment thread src/content/docs/docs/for-docs/work-the-queue/giving-feedback.mdx
Comment thread src/content/docs/docs/for-docs/starport/connections.mdx
Comment thread src/content/docs/docs/for-docs/start-here/quickstart.mdx
Comment thread src/content/docs/docs/for-docs/start-here/quickstart.mdx
Comment thread src/content/docs/docs/for-docs/start-here/quickstart.mdx
Comment thread src/content/docs/docs/for-docs/audit/doc-detective.mdx
<Aside type="note">
If your Vale config references external style packages (like Microsoft, Google, or write-good), Promptless downloads them automatically. This happens the first time it lints during a session.
</Aside>
3. In **Vale config path**, enter the repo-relative path to your Vale configuration file, such as `.vale.ini` or `docs/.vale.ini`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation

The Vale config path field sits under a doc collection's More filters (optional) expander on the Configuration page's Doc collections tab.

Source: DocCollectionsSection.tsx:543–548 · b2b32f4

This branch was successfully deployed

1 active deployment
Preview — 67eaec1c Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants