Skip to content

Add pgflow-docs agent skill and documentation API endpoint - #618

Merged
jumski merged 1 commit into
mainfrom
agent-skills
Aug 22, 2026
Merged

Add pgflow-docs agent skill and documentation API endpoint#618
jumski merged 1 commit into
mainfrom
agent-skills

Conversation

@jumski

@jumski jumski commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds a public pgflow-docs Agent Skill and small, generated documentation indexes that let coding agents fetch current pgflow documentation on demand.

Agent Skill

  • Publishes skills/pgflow-docs/SKILL.md in the conventional skills repository location.
  • Routes agents directly to the documentation section matching the task.
  • Fetches current remote Markdown instead of bundling documentation that becomes stale.
  • Distinguishes current documentation from news: docs define current behavior and APIs; news records what shipped and when.
  • Remains installable with npx skills add pgflow-dev/pgflow --skill pgflow-docs without a manifest.

Documentation indexes

  • Generates /docs-index.md plus section indexes for Get Started, Build, Deploy, Concepts, Reference, Tutorials, News, and Comparisons.
  • Builds indexes from Astro's docs content collection rather than crawling files directly.
  • Uses content metadata for routing: title, description, optional agent-specific hint, sidebar order, date, and draft state.
  • Links to the existing raw Markdown page endpoints.
  • Keeps each section small so agents fetch one index and only the pages needed for the task.

Scope boundaries

  • No changes to /llms.txt or starlight-llms-txt.
  • No bundled documentation.
  • No new Starlight or Astro plugin.
  • No skills.sh.json; it is unnecessary for one skill.
  • No generic agent tags or speculative metadata.

@changeset-bot

changeset-bot Bot commented Mar 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 81f03d5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

jumski commented Mar 23, 2026

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@nx-cloud

nx-cloud Bot commented Mar 23, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 81f03d5

Command Status Duration Result
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded <1s View ↗
nx affected -t build --configuration=production... ✅ Succeeded <1s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded 2s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-08-21 21:10:07 UTC

@jumski

jumski commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

Reworking this PR based on review:

  • Move the public skill to skills/pgflow-docs/.
  • Generate small section indexes from the Astro content collection, including a separate news index.
  • Route the skill directly to one section index, then fetch relevant page Markdown.
  • Keep llms.txt and its Starlight plugin unchanged; do not bundle documentation.
  • Use existing descriptions by default; add an optional agent-specific hint only where routing checks show a real need.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Preview Deployment: Website

Deployment successful!

🔗 Preview URL: https://pr-618.pgflow.pages.dev

📝 Details:

  • Branch: agent-skills
  • Commit: aab0810335267f15c8fb79b0df581fcdf1a42e2a
  • View Logs

_Last updated: _

jumski commented Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

Merge activity

  • Aug 22, 12:16 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 22, 12:16 AM UTC: @jumski merged this pull request with Graphite.

@jumski
jumski merged commit c1812df into main Aug 22, 2026
16 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Production Deployment: Website

Successfully deployed to production!

🔗 Production URL: https://pgflow.dev

📝 Details:

  • Commit: c1812df167d17b92c6d5ebeac0eec850f35edd65
  • View Logs

Deployed at: 2026-08-22T02:16:46+02:00

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant