Skip to content

Conversation

BlenderDude
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented Jun 6, 2025

⚠️ No Changeset found

Latest commit: e615d50

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@BlenderDude BlenderDude changed the title updates [do not merge] PR for docs CICD test Jun 6, 2025
Copy link

codesandbox-ci bot commented Jun 6, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@apollo-librarian
Copy link

apollo-librarian bot commented Jun 6, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 14 changed, 0 removed
* (developer-tools)/kotlin/v3/advanced/apollo-ast.mdx
* (developer-tools)/kotlin/v3/advanced/multi-modules.mdx
* (developer-tools)/kotlin/v3/advanced/no-runtime.mdx
* (developer-tools)/kotlin/v3/advanced/rxjava.mdx
* (developer-tools)/kotlin/v3/caching/http-cache.mdx
* (developer-tools)/kotlin/v3/caching/normalized-cache.mdx
* (developer-tools)/kotlin/v3/essentials/custom-scalars.mdx
* (developer-tools)/kotlin/v3/testing/mocking-graphql-responses.mdx
* (developer-tools)/kotlin/v3/testing/mocking-http-responses.mdx
* (developer-tools)/kotlin/v3/testing/ui-tests.mdx
* (developer-tools)/kotlin/v3/tutorial/01-configure-project.mdx
* (developer-tools)/kotlin/v3/index.md
* graphos/schema-design/federated-schemas/reference/moving-to-federation-2.mdx
* graphos/schema-design/federated-schemas/composition.mdx

Build ID: d898f6174b898714d9562e1e

URL: https://www.apollographql.com/docs/deploy-preview/d898f6174b898714d9562e1e

Copy link

@apollo-librarian apollo-librarian bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request has 2 style issues. Please review the changes and make the necessary adjustments.

---

In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema:
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence is grammatically incorrect and unclear. It should state what schema composition is.

Suggested change
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema.

</CodeColumns>

One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails.
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML code tags (<code>) should be replaced with Markdown's backticks (`) for inline code snippets to ensure consistent formatting across the documentation site.

Suggested change
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails.
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails.

Copy link

@apollo-librarian apollo-librarian bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Style Review Summary

⚠️ This review and suggested changes are AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

The documentation has undergone extensive formatting and consistency improvements. Numerous leading spaces were removed from various elements including code blocks, headings, HTML tags, and notes to ensure proper rendering and alignment. Indentation within Mermaid diagrams and YAML code blocks was adjusted to maintain consistency, primarily to a 2-space standard. Grammatical clarity was enhanced by rephrasing an incomplete sentence and replacing 'But' with 'However' for a more formal tone. For inline code snippets, <code> tags were replaced with backticks to align with standard Markdown practices and style guide preferences, improving overall code block rendering and readability. Additionally, 'of the' was removed from a phrase for conciseness.

The pull request has 67 style issues. Please review the changes and make the necessary adjustments.

If you encounter any issues with this AI review, please reach out to Developer Experience Marketing for assistance.

---

In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema:
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence is grammatically incomplete and unclear. It should state what 'is the process' refers to. Rephrased to clarify and improve readability.

Suggested change
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema in Apollo Federation:

composition -- "(Composition succeeds)" --> supergraph;
class composition tertiary;
```
```mermaid

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure proper code block rendering and consistency.

Suggested change
```mermaid
```mermaid

class composition tertiary;
```
```mermaid
graph TB;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure proper code block rendering and consistency.

Suggested change
graph TB;
graph TB;

```
```mermaid
graph TB;
serviceA[Subgraph<br/>schema<br/>A];

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.

Suggested change
serviceA[Subgraph<br/>schema<br/>A];
serviceA[Subgraph<br/>schema<br/>A];

```mermaid
graph TB;
serviceA[Subgraph<br/>schema<br/>A];
serviceB[Subgraph<br/>schema<br/>B];

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.

Suggested change
serviceB[Subgraph<br/>schema<br/>B];
serviceB[Subgraph<br/>schema<br/>B];

<Note>

For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces for consistency within the note.

Suggested change
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

</Note>
</Note>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure proper rendering of the HTML tag and consistency.

Suggested change
</Note>
</Note>

</Note>

Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced 'But' with 'However' to maintain a more formal and professional tone in technical documentation.

Suggested change
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. However, that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

## Next steps
## Next steps

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure proper heading rendering and consistency.

Suggested change
## Next steps
## Next steps

## Next steps

Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces for consistency.

Suggested change
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)

Copy link

@apollo-librarian apollo-librarian bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Style Review Summary

⚠️ This review and suggested changes are AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

This pull request includes numerous formatting corrections, primarily by removing leading spaces to ensure correct rendering of code blocks, headings, content, admonitions, HTML tags, and shortcodes. Grammatical and stylistic improvements were also made, such as rephrasing a sentence for clarity, replacing 'of the' for conciseness, using backticks for inline code for consistency with Markdown, replacing 'take a look at' with 'consider' for conciseness, capitalizing 'Federation' for product reference, and replacing 'But that' with 'This' for better flow.

The pull request has 67 style issues. Please review the changes and make the necessary adjustments.

If you encounter any issues with this AI review, please reach out to Developer Experience Marketing for assistance.

---

In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema:
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence is grammatically incorrect and missing a subject. Rephrased for clarity and proper sentence structure.

Suggested change
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema:
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema in Apollo Federation.

composition -- "(Composition succeeds)" --> supergraph;
class composition tertiary;
```
```mermaid

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the code block is correctly rendered.

Suggested change
```mermaid
```mermaid

class composition tertiary;
```
```mermaid
graph TB;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the code block is correctly rendered.

Suggested change
graph TB;
graph TB;

```
```mermaid
graph TB;
serviceA[Subgraph<br/>schema<br/>A];

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the code block is correctly rendered.

Suggested change
serviceA[Subgraph<br/>schema<br/>A];
serviceA[Subgraph<br/>schema<br/>A];

```mermaid
graph TB;
serviceA[Subgraph<br/>schema<br/>A];
serviceB[Subgraph<br/>schema<br/>B];

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the code block is correctly rendered.

Suggested change
serviceB[Subgraph<br/>schema<br/>B];
serviceB[Subgraph<br/>schema<br/>B];

<Note>

For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the content is correctly rendered.

Suggested change
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types).

</Note>
</Note>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the admonition is correctly rendered.

Suggested change
</Note>
</Note>

</Note>

Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize "Federation" as it refers to the product. Replace "But that" with "This" for better flow and conciseness, avoiding the slightly informal tone.

Suggested change
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.
Breaking composition is a helpful feature of Federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. This conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details.

## Next steps
## Next steps

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the heading is correctly rendered.

Suggested change
## Next steps
## Next steps

## Next steps

Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove leading spaces to ensure the content is correctly rendered.

Suggested change
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart)

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.

1 participant