Skip to content

docs: Document auditing docs for broken links on request or on a schedule - #1094

Open
promptless[bot] wants to merge 12 commits into
mainfrom
promptless/link-audit-example
Open

promptless[bot] wants to merge 12 commits into
mainfrom
promptless/link-audit-example

Conversation

@promptless

@promptless promptless Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Proposed changes

Documents the link audit from Promptless/promptless#5337, now merged. Promptless can crawl a published docs site with its built-in link checker, then fix what it reports in a suggestion. The checker reports broken links, missing anchors, and links that permanently redirect (301 or 308) to a new URL. You can run it on request or on a schedule trigger.

  • New page: Example: Audit your docs for broken links under Teach Promptless a custom task. It covers prerequisites, including that the site must be on a public URL. It also covers one-off requests, a schedule trigger YAML example with the site URL in the instructions, and what the audit reports. External links are checked only when the request asks for them, and temporary redirects count as working links.
  • Schedule triggers page: the use-case list links to the new page.
  • Page metadata: the new page now meets the manni frontmatter rules that #1177 added. It has an id, type: how-to instead of type: guide, and the fields its sibling example pages carry. It has an Overview and a See also section, and its docs.metadata.yaml entry carries created and owner. The parent page's next-steps list now includes it.
  • Teach Promptless a custom task: adds a LinkCard for the new example. It also rewrites the sentence that called all custom tasks event-driven, because schedule triggers run recurring checks.
  • October 2026 changelog: new month file with a New Features entry.

This revision brings the earlier draft in line with the merged source PR. The merged PR adds no link-audit skill, so the following claims were removed: the docs_root_url crawl requirement, rechecking 403 and 429 links, archived-copy fixes, and quiet runs. The changelog entry moved from September to October 2026, because the source PR merged on October 7, 2026 (UTC).

Checklist

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

Verification: npm run build, lint:md, manni meta validate (132 of 132 pages pass), and manni lint structure on the new page passed. Vale reported no new findings. The link checker's redirect handling is covered by source unit tests, but nobody has run it against a live site.

@vercel

vercel Bot commented Sep 30, 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 5:54pm UTC

Request Review

Comment thread src/content/docs/docs/for-docs/connect/triggers/schedule.mdx Outdated
…-example

# Conflicts:
#	src/content/changelog/changelogs/september-2026.mdx
…-example

# Conflicts:
#	src/content/changelog/changelogs/october-2026.mdx
…-example

# Conflicts:
#	src/content/changelog/changelogs/october-2026.mdx
…-example

# Conflicts:
#	src/content/changelog/changelogs/october-2026.mdx
…-example

# Conflicts:
#	src/content/docs/docs/for-docs/connect/triggers/schedule.mdx
#	src/content/docs/docs/for-docs/get-the-most-out/teach-promptless-a-custom-task.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.

This branch was successfully deployed

1 active deployment
Preview — 12a46d40 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