@techspokes/typescript-wsdl-client 0.10.1 → 0.10.2

package/docs/AGENTS.md

@@ -0,0 +1,47 @@
+# Agent Instructions for docs/
+
+## Summary
+
+This directory contains human-maintained reference documentation for `@techspokes/typescript-wsdl-client`. Documents here are not generated; agents may edit them but must preserve cross-references, formatting conventions, and consistency with the root README.
+
+## Must-follow rules
+
+- Maintain cross-references between documents; when a doc mentions a related topic, link to the relevant file.
+- Use relative links for all internal references (e.g. `[CLI Reference](cli-reference.md)`, `[root README](../README.md)`).
+- Each document must open with an H1 title, a one-line description, and a cross-reference to the root [README.md](../README.md).
+- When adding, renaming, or removing a document, update the Documentation table in the root [README.md](../README.md) — that table is the single source of truth for this directory's contents.
+- Do not duplicate content from root-level files (README.md, CONTRIBUTING.md, CHANGELOG.md); link to them instead.
+
+## Must-read documents
+
+- [Root README.md](../README.md): authoritative Documentation table and project overview
+- [Root AGENTS.md](../AGENTS.md): project-wide agent instructions pointing to `.github/copilot-instructions.md` for full detail
+
+## Agent guidelines
+
+### Style conventions
+
+- Use fenced code blocks for CLI examples and inline code for flag names (`` `--flag-name` ``).
+- Keep language direct and task-oriented.
+- `architecture.md` targets contributors; all other documents target users.
+
+### Adding a new document
+
+1. Create the file in `docs/` with an H1 title and description.
+2. Add a row to the Documentation table in the root README.md.
+3. Add a bullet to the Contents list in `docs/README.md`.
+4. Cross-reference from related existing documents where appropriate.
+
+### Editing existing documents
+
+- Preserve the H1 + description + cross-reference opening pattern.
+- If renaming a file, update the root README.md Documentation table and fix any relative links in other docs.
+
+## Context
+
+The `docs/` directory was introduced in v0.8.x to move detailed reference material out of the root README. `architecture.md` covers the internal pipeline for contributors; the remaining documents serve end users integrating with or deploying generated code.
+
+## References
+
+- [examples/README.md](../examples/README.md): folder README pattern example
+- [Root README.md Documentation table](../README.md#documentation): authoritative listing of all docs

package/docs/README.md

@@ -0,0 +1,35 @@
+# Documentation
+
+Human-maintained reference documents for `@techspokes/typescript-wsdl-client`. The root [README.md](../README.md) Documentation table is the authoritative index with descriptions; the list below is a quick local reference.
+
+## Contents
+
+- [api-reference.md](api-reference.md) – Programmatic TypeScript API
+- [architecture.md](architecture.md) – Internal pipeline for contributors
+- [cli-reference.md](cli-reference.md) – All 6 commands with flags and examples
+- [concepts.md](concepts.md) – Flattening, `$value`, primitives, determinism
+- [configuration.md](configuration.md) – Security, tags, operations config files
+- [gateway-guide.md](gateway-guide.md) – Fastify integration and error handling
+- [generated-code.md](generated-code.md) – Using clients and types
+- [migration.md](migration.md) – Upgrade paths between versions
+- [production.md](production.md) – CI/CD, validation, logging, limitations
+- [troubleshooting.md](troubleshooting.md) – Common issues and debugging
+
+## Conventions
+
+- Each document opens with an H1 title and a one-line description.
+- Cross-reference related documents and the root README where relevant.
+- Use fenced code blocks for CLI examples; format flags as inline code (`` `--flag-name` ``).
+- Keep language direct and task-oriented; architecture.md targets contributors, all others target users.
+
+## Related
+
+- [Root README](../README.md) – project overview, quick start, and authoritative Documentation table
+- [CONTRIBUTING.md](../CONTRIBUTING.md) – development setup and workflow
+- [CHANGELOG.md](../CHANGELOG.md) – version history
+- [examples/](../examples/) – sample WSDL files and generated output
+
+## Not Here
+
+- Generated code samples live in `examples/generated-output/`, not in `docs/`.
+- Installation and dev setup belong in the root README and CONTRIBUTING.md respectively.

package/llms.txt

@@ -47,5 +47,7 @@ npx wsdl-tsc pipeline \
 - README.md: project overview and quick start
 - CONTRIBUTING.md: development setup, project structure, testing strategy
 - docs/migration.md: upgrade paths between versions
+- .github/copilot-instructions.md: authoritative detailed agent instructions (referenced by AGENTS.md)
+- docs/README.md: documentation directory index and conventions
 - npm: https://www.npmjs.com/package/@techspokes/typescript-wsdl-client
 - GitHub: https://github.com/TechSpokes/typescript-wsdl-client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techspokes/typescript-wsdl-client",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "Generate type-safe TypeScript SOAP clients, OpenAPI 3.1 specs, and production-ready Fastify REST gateways from WSDL/XSD definitions.",
   "keywords": [
     "wsdl",