@rytass/wms-module-graphql 0.1.2 → 0.1.4

package/README.md

@@ -72,6 +72,21 @@ Custom context factories from `gqlOptions.useFactory` are merged with the loader
 
 The schema is generated at boot via `autoSchemaFile` (above). Commit the resulting `schema.gql` to your repo if you want downstream codegen (e.g. for `@rytass/wms-module-react`) to consume a stable schema snapshot.
 
+## Documentation
+
+Full documentation is shipped inside this package under the `docs/` directory (available after `npm install`):
+
+| Document | Description |
+|---|---|
+| [`docs/integration-guide.md`](./docs/integration-guide.md) | Step-by-step wiring guide for NestJS + Next.js consumers |
+| [`docs/api-reference.md`](./docs/api-reference.md) | Complete export catalog with signatures and usage examples |
+
+GitHub hosted links (always up-to-date):
+
+- [Integration Guide — §4 Backend setup](https://github.com/Rytass/WMS-Module/blob/main/docs/integration-guide.md#4-backend-setup-nestjs--graphql--typeorm)
+- [Integration Guide — §13.1 Existing GraphQLModule co-existence](https://github.com/Rytass/WMS-Module/blob/main/docs/integration-guide.md#13-integrating-into-an-existing-nestjs--nextjs-project)
+- [API Reference — @rytass/wms-module-graphql](https://github.com/Rytass/WMS-Module/blob/main/docs/api-reference.md#rytasswms-module-graphql)
+
 ## License
 
 MIT

package/docs/README.md

@@ -0,0 +1,33 @@
+# Documentation
+
+Reference material for consumers of `@rytass/wms-module-{core,graphql,react}`.
+
+## Contents
+
+| Document                                       | Description                                                                                       |
+|------------------------------------------------|---------------------------------------------------------------------------------------------------|
+| [Integration Guide](./integration-guide.md)    | Step-by-step instructions for wiring the three packages into a new consumer project (NestJS + Next.js + PostgreSQL). Includes ready-to-paste `_app.tsx`, `app.module.ts`, `next.config.ts`, the 19 Pages Router shell pattern, AuthGuard stub, seed script template, deployment notes, and known issues. |
+| [API Reference](./api-reference.md)            | Complete export catalog for all three packages — every NestJS module, TypeORM entity, GraphQL resolver, DTO, React component, hook, and utility, organized by role with source paths and usage examples. Mirrors the actual `src/index.ts` barrel exports of v0.1.2. |
+
+## Quick links
+
+- Reference implementation: the maintainers' standalone consumer demo at `~/Downloads/wms-standalone`.
+- This monorepo's `apps/api` (NestJS backend) and `apps/client` (Next.js frontend) are the dogfooded equivalents.
+- Release process: see [`RELEASING.md`](../RELEASING.md).
+
+## Audience
+
+| If you want to...                                       | Start at...                                                            |
+|---------------------------------------------------------|------------------------------------------------------------------------|
+| Stand up a new WMS consumer from scratch                | [Integration Guide section 3](./integration-guide.md#3-quick-start-60-seconds) |
+| Look up a specific export's signature                   | [API Reference](./api-reference.md)                                    |
+| Understand why the lib needs `transpilePackages`        | [Integration Guide section 5.3](./integration-guide.md#53-appsclientnextconfigts) |
+| Replace the `AuthGuard` stub with real auth             | [Integration Guide section 8.4](./integration-guide.md#84-real-auth-integration) |
+| Decide between PostgreSQL and SQLite                    | [Integration Guide section 9](./integration-guide.md#9-database-support-matrix) |
+| Build a custom UI on top of the lib's GraphQL operations| [Integration Guide section 7.3](./integration-guide.md#73-graphql-operations--typed-hooks) |
+
+## Versioning
+
+These documents track the **latest published `0.1.x` release**. Anything in `main` that has not yet been released is marked clearly inline; otherwise assume the documented signature matches the current npm-published library.
+
+When you upgrade the lib, check each package's `CHANGELOG.md` for breaking changes that may affect the snippets here.