chore: clarify drawbacks of introspection publish

apollographql · Oct 7, 2021 · 5771920 · 5771920
1 parent 9ece7de
commit 5771920
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/graphs.md b/docs/source/graphs.md
@@ -89,6 +89,8 @@ If your schema isn't stored in a compatible file, you can provide `-` as the val
 rover graph introspect http://localhost:4000 | rover graph publish my-graph@dev --schema -
 ```
 
+Whenever possible, we recommend publishing a `.graphql` file directly instead of using introspection. An introspection result omits schema comments and most uses of directives.
+
 > For more on accepting input via `stdin`, see [Conventions](./conventions#using-stdin).
 
 ## Checking schema changes