Add example for adding basic content type filters

[MikeKry]

Fixes #16112

[Piedone]

@coderabbitai review

[Piedone]

@coderabbitai review

[coderabbitai]

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Walkthrough

The recent updates to the README.md file for src/docs/reference/core/Apis.GraphQL.Abstractions introduce comprehensive guidance on defining custom query filter types, implementing default Content Type query filters, and utilizing arguments for query filtration in GraphQL. These enhancements aim to simplify the process for developers by providing detailed instructions and examples, thereby addressing common challenges faced when creating basic content type filters.

Changes

File Path	Change Summary
src/docs/reference/core/Apis.GraphQL.Abstractions/README.md	Added sections on defining custom query filter types, implementing default Content Type query filters, and using arguments for query filtration. Provided examples and detailed instructions for each.

Assessment against linked issues

Objective	Addressed	Explanation
Enhance documentation to guide developers through creating basic content type filters (#16112)	✅
Provide clear steps for using WhereInputQueryObjectType and registering IIndexAliasProvider (#16112)	✅
Include examples of implementing AutorouteInputObjectType and AutoroutePartIndexAliasProvider (#16112)	✅
Update Startup class with configurations for registering filters (#16112)	✅

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 7

Outside diff range and nitpick comments (5)

src/docs/reference/core/Apis.GraphQL.Abstractions/README.md (5)

Line range hint 28-28: Correct the possessive form for clarity.

- Lets see how to wire a type in to the GraphQL schema;
+ Let's see how to wire a type into the GraphQL schema;

---

Line range hint 31-31: Correct the possessive form for clarity.

- First: Lets start with a simple C# part
+ First: Let's start with a simple C# part

---

Line range hint 61-61: Simplify the language for better readability.

- To do this, simple register it in a Startup class;
+ To do this, simply register it in a Startup class;

---

Line range hint 125-125: Simplify the language for better readability.

- all Input Types must inherit off of InputObjectGraphType.
+ all Input Types must inherit from InputObjectGraphType.

---

Line range hint 371-372: Ensure consistency in list item markers.

- - <https://graphql.org/learn/>
- - <https://graphql-dotnet.github.io/docs/getting-started/introduction>
+ * <https://graphql.org/learn/>
+ * <https://graphql-dotnet.github.io/docs/getting-started/introduction>

[Piedone]

Please run the docs site locally and check it out in a browser before the next review: https://docs.orchardcore.net/en/latest/guides/contributing/contributing-documentation/#running-the-documentation-site-locally

[MikeKry]

@Piedone
I have merged your suggestions and also made some little changes based on built version of the documentation.

screenshot of built docs:

I may also learn to write in proper english if I keep updating the documentation :D

[Piedone]

@hishamco please merge when you're happy with it.