Skip to content

[Docs] Document @atls/nestjs-gateway package #419

Description

@TorinAsakura

Where did the changes happen?

@atls/nestjs-gateway public package documentation after the Apollo Server 5 and GraphQL Mesh runtime migration

What will be documented

Document the package as a public NestJS gateway integration package instead of leaving consumers to infer behavior from source code.

The documentation should cover:

  • package purpose and supported gateway scenario
  • installation and peer dependency expectations
  • minimal Nest module setup
  • GraphQL Mesh handler setup
  • Express adapter behavior after the Apollo Server 5 migration
  • Fastify adapter state once the gateway adapter task is complete
  • playground, introspection, health check, upload and subscription behavior
  • gRPC metadata forwarding and error formatting behavior
  • testing notes that point to the restored integration contour

Create README.md as the default English document and README_RU.md as the Russian version. Keep both documents useful for the public repository and avoid source-file retelling.

Does this break backward compatibility?

No

Link to the initiating task

#329

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions