Skip to content

chore: add LLM and agent entry points (root and packages)#1095

Open
premsgr wants to merge 43 commits into
mainfrom
chore/llm-docs
Open

chore: add LLM and agent entry points (root and packages)#1095
premsgr wants to merge 43 commits into
mainfrom
chore/llm-docs

Conversation

@premsgr

@premsgr premsgr commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

chore: add LLM and agent entry points (root and packages)

Summary

This branch standardizes AI-agent documentation across the monorepo and package-level artifacts so both humans and agents follow a clear read order.

The diff includes monorepo guidance files (AGENTS.md and docs/llm/*) for source-checkout workflows, plus package-local agent docs for config, error-handler, firebase, graphql, mailer, s3, slonik, swagger, and user that are intended for published-package consumption.

What changed

  • Added repo-level agent entrypoints and LLM documentation index/reference/changelog.
  • Added per-package AGENTS.md, docs/llm/INDEX.md, and docs/llm/EXAMPLES.md for all maintained packages.
  • Updated package README.md files with agent-facing pointers and generated public API sections.
  • Updated package package.json files entries so package docs and agent metadata are published with npm artifacts.
  • Updated root package.json and lockfile metadata in support of docs publishing metadata changes.

Scope notes

  • Root docs/ is monorepo documentation for source checkouts and is not part of built package artifacts.
  • AI agents consuming installed/published packages should use package-local docs (README.md, AGENTS.md, and docs/llm/*) shipped via each package files config.
  • This PR is documentation and packaging-metadata focused.
  • No runtime behavior changes are intended for package plugins.

@premsgr premsgr changed the base branch from main to pre-upgrade April 24, 2026 12:56
@premsgr premsgr changed the title chore: documentation, tooling, tests, fixes, and LLM agent materials chore: add LLM and agent entry points (root and packages) Apr 24, 2026
premsgr and others added 5 commits April 27, 2026 14:32
…bles

Add scripts/docgen with Handlebars templates, docgen.manifest.json for
package order and curated demo test links, pnpm docs:generate and
verify:llm-docs CI step. README sections use docgen markers; REFERENCE
uses package section markers.
Base automatically changed from pre-upgrade to main April 28, 2026 02:49
premsgr added 2 commits April 28, 2026 12:09
…-docs

# Conflicts:
#	README.md
#	packages/config/README.md
#	packages/error-handler/README.md
#	packages/slonik/README.md
Add LLM entry points and generated export tables for config,
error-handler, and slonik. Bump Last verified SHA in REFERENCE.md.
@premsgr premsgr requested a review from uddhab April 28, 2026 10:20
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.

2 participants