Skip to content

docs: Document Heretto CCMS doc collections - #1078

Open
promptless[bot] wants to merge 15 commits into
mainfrom
promptless/heretto-ccms-doc-collections
Open

promptless[bot] wants to merge 15 commits into
mainfrom
promptless/heretto-ccms-doc-collections

Conversation

@promptless

@promptless promptless Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Open in Promptless

Proposed changes

Documents Heretto CCMS as a doc location, added in Promptless/promptless#5310, the dashboard connect flow added in Promptless/promptless#5546, in-Heretto review added in Promptless/promptless#5556, the per-file Heretto links from Promptless/promptless#5650, and the dashboard folder browser from Promptless/promptless#5657. Teams that write DITA in Heretto can connect their tenant from the Integrations page, point a doc collection at a Heretto folder, and send Promptless suggestions into Heretto, where writers accept or reject each change in the topic editor.

  • New page connect/doc-locations/heretto-ccms.mdx: how Promptless reads the folder, saves suggestions, writes them into Heretto as Heretto suggestions, and records the review outcome; how to connect a tenant from the Integrations page with a host, username, and API token, what happens when Heretto rejects the credentials, the one-connection-per-org rule, and the daily health check, Check access, and Disconnect Heretto; how to add the collection by browsing Heretto folders on the Configuration page, or in YAML mode with the folder ID; the Suggest in Heretto action and reviewing with Accept Change / Reject Change; which files Promptless can change; and what to do when Promptless can't write a suggestion into Heretto.
  • Configuration reference: adds heretto to platform, documents host and the new root_folder_id field, notes that default_branch is invalid for Heretto, and adds a Heretto YAML example.
  • Integrations list: adds Heretto CCMS.
  • Vale Promptless.Headings: adds Heretto and Heretto CCMS to the proper-noun exceptions.

Revised for #5546

The Connect Heretto section walks through the Heretto card on the Integrations page: generate a token, enter the host, username, and token, and select Connect. Promptless saves the credentials only after Heretto accepts them.

Revised for #5556

Publishing a Heretto suggestion now writes each change into the topic as a Heretto suggestion instead of overwriting the file. The page now covers:

  • The dashboard's rendered DITA diff with the View source toggle.
  • Suggest in Heretto, the Review in Heretto link, and per-file Open in Heretto links.
  • A new "Review changes in Heretto" procedure: right-click a change and choose Accept Change or Reject Change. Promptless checks hourly and marks the suggestion Accepted in Heretto (merged) or, when every change was rejected, Rejected in Heretto (closed).
  • New-file behavior: a rejected new topic leaves an empty topic to delete, and deleting it counts as rejection.
  • A new refusal row for changes Heretto suggestions can't express, such as a root-element change or unparseable XML.

The configuration reference and integrations list descriptions now say changes go to writers to accept or reject instead of being published back.

No changelog entry is included. The October 2026 entry was removed from this branch in a reviewer edit on 2026-10-14, and this revision doesn't re-add it.

Revised for #5650

The review page no longer shows a Heretto card for the collection; each file's diff keeps its Open in Heretto link. The "Send a suggestion to Heretto for review" section now adds that when those links can't load, the review page says why, with Connect Heretto when Heretto isn't connected and Try again when Heretto didn't answer.

Revised for #5657

Heretto collections can now be added and edited in Form mode. The "Add a Heretto doc collection" section now covers:

  • The Form-mode procedure: Add doc collection, the Browse folders on your Heretto host entry, opening a repository and folders, Use this folder, and Add collection.
  • The browser lists only repositories the connected Heretto account can read, and marks folders another collection covers as Already a doc collection, which can be opened but not chosen.
  • The key the dashboard gives a new collection, such as acme/product-manual, with a numeric suffix on a clash.
  • Change under Heretto folder on an existing collection, which also sets Heretto host to the connected host.
  • A table of folder-listing problems (rejected credentials, a folder the account can't open, a deleted folder, Heretto not responding) and what to do.
  • The YAML procedure moves to a "Configure a Heretto doc collection in YAML" subsection, still with the Resource Drawer folder ID.

The configuration reference no longer says Heretto collections must be added in YAML mode, and says the dashboard derives a Heretto collection's key.

Synced with main for the manni frontmatter check

This branch now includes the latest main, which brings in the manni frontmatter validation from #1165. To pass that check:

  • The Heretto CCMS page gets the same frontmatter fields as the other doc-location pages (id, keywords, audiences, intent, applies-to, concepts, related-pages, risks, sample-questions), and docs.metadata.yaml gets a matching entry. Promptless proposed these values, so the entry lists them under meta-provenance for review.
  • npx manni meta derive restamped created, last-updated, and owner on the Heretto page and last-updated on the configuration reference and integrations list. These are the only pages this PR changes. npx manni meta validate now passes on all 133 pages under Node 24.
  • The page is now type: how-to, like the GitHub and GitLab doc-location pages, with an Overview heading over the intro and a See also list. npx manni lint structure passes on it.

Open items for review

  • Not verified against a live Heretto tenant. The source PRs test CCMS calls against fakes. The #5556 exec plan records verification on a Heretto tenant: Accept Change / Reject Change resolve API-written suggestions, a rejected new topic is left as an empty root element, and accepting or rejecting a whole new topic shows TypeError toasts while the save still succeeds. UI labels come from HerettoIntegrationCard.tsx, BulkActionsBar.tsx, FileDiffEditor.tsx, HerettoLinksProblem.tsx, HerettoFolderBrowser.tsx, and DocCollectionsSection.tsx.
  • #5657 notes that a successful folder listing against a live tenant had not yet been confirmed when it merged.
  • The "revise an open suggestion" paragraph describes revising before a suggestion is written into Heretto. #5556 doesn't say how a revision behaves after the changes are already in Heretto for review, so the page doesn't cover that case.

Checklist

  • Instructions and examples match the current product behavior.
  • Links and image references are valid.
  • Changed pages render correctly.

@vercel

vercel Bot commented Sep 28, 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 6:07pm UTC

Request Review

Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/configuration-reference.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/configuration-reference.mdx Outdated
Comment thread src/content/changelog/changelogs/september-2026.mdx Outdated
…ms-doc-collections

# Conflicts:
#	src/content/changelog/changelogs/september-2026.mdx
@promptless

promptless Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

…ms-doc-collections

# Conflicts:
#	src/content/docs/docs/for-docs/reference/configuration-reference.mdx
…ms-doc-collections

# Conflicts:
#	src/content/docs/docs/for-docs/reference/configuration-reference.mdx
#	src/content/docs/docs/for-docs/reference/integrations.mdx
Comment thread src/content/docs/docs/for-docs/connect/doc-locations/heretto-ccms.mdx Outdated

This branch was successfully deployed

1 active deployment
Preview — ca9c1391 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.

1 participant