docs: /docs/concepts/features-overview/
#725
Conversation
WalkthroughThe recent updates involve significant changes across various components and documentation files. Key modifications include updating platform specifications in the lock file, enhancing documentation with new import statements and example structures, and refining the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 25
Out of diff range and nitpick comments (7)
website/docs/reference/runtimes/graphql/index.mdx (1)
Line range hint
13-15: The addition of theTGExamplecomponent with Python and TypeScript examples is correctly implemented.To address the static analysis hints, ensure that the
requirestatements are correctly paired with double quotes:- python={require("../../../../../examples/typegraphs/graphql.py")} - typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} - query={require("./graphql.graphql")} + python={require("../../../../../examples/typegraphs/graphql.py")} + typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} + query={require("./graphql.graphql")}website/src/pages/features/index.tsx (2)
23-23: Use a more descriptive class name.Consider using a more descriptive class name instead of "gap-2 flex max-w-full my-10" to improve readability and maintainability.
82-82: Use a more descriptive class name.Consider using a more descriptive class name instead of "flex flex-col gap-1" to improve readability and maintainability.
website/docs/guides/external-functions/index.mdx (1)
Line range hint
69-69: Add missing article.Consider adding "the" before "rest of functionality" for better readability.
- To do anything meaningful with custom functions, you'll want to access the rest of functionality implemented on your typegraph. + To do anything meaningful with custom functions, you'll want to access the rest of the functionality implemented on your typegraph.website/docs/guides/securing-requests/index.mdx (1)
Line range hint
47-47: Add missing article.Consider adding "a" before "guard" for better readability.
- `from_context` acts as guard preventing the materalizer from being accessed unless the named data is found in the context. + `from_context` acts as a guard preventing the materalizer from being accessed unless the named data is found in the context.website/src/components/MiniQL/index.tsx (2)
86-89: Use a more descriptive class name.Consider using a more descriptive class name instead of "md:grid @2XL:grid-cols-2" to improve readability and maintainability.
146-146: Use a more descriptive class name.Consider using a more descriptive class name instead of "flex flex-col graphiql-container" to improve readability and maintainability.
Yohe-Am
force-pushed
the
docs/features-overview
branch
from
71e4f27 to
59337ee
Compare
There was a problem hiding this comment.
Actionable comments posted: 33
Out of diff range and nitpick comments (12)
website/docs/guides/rest/index.mdx (3)
Line range hint
23-23: Use a hyphen in "browser-based".- A browser based explorer for the OpenAPI schema is served under `{typegate_url}/{typegraph}/rest` as well. + A browser-based explorer for the OpenAPI schema is served under `{typegate_url}/{typegraph}/rest` as well.
Line range hint
25-25: Consider changing "todo" to "to-do" or "to do".- {/* todo: link to the expample's redoc*/} + {/* to-do: link to the example's redoc*/}
Line range hint
25-25: TODO: Add link to the example's redoc.Do you want me to generate the link or open a GitHub issue to track this task?
website/shared/s3/index.mdx (1)
Line range hint
8-8: Use "set up" instead of "setup" as a verb.- For the following example, you'll need to setup your S3 compatible store first. + For the following example, you'll need to set up your S3 compatible store first.website/docs/reference/runtimes/graphql/index.mdx (2)
Line range hint
13-15: Fix the unpaired quotation marks in therequirestatements.- python={require("../../../../../examples/typegraphs/graphql.py")} - typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} - query={require("./graphql.graphql")} + python={require("!!code-loader!../../../../../examples/typegraphs/graphql.py")} + typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} + query={require("!!code-loader!./graphql.graphql")}
Line range hint
23-23: Correct the grammatical number of the noun.- Other type enforcement rules also exists: + Other type enforcement rules also exist:website/docs/guides/external-functions/index.mdx (1)
Line range hint
69-69: Add the missing article.- you'll want to access the rest of functionality implemented on your typegraph. + you'll want to access the rest of the functionality implemented on your typegraph.website/docs/guides/securing-requests/index.mdx (5)
Line range hint
25-25: Consider a shorter alternative to avoid wordiness.- The following example uses basic authentication in order to only allow access for admin users. + The following example uses basic authentication to allow access only for admin users.
Line range hint
59-59: Use a hyphen for "policy-based".- The primary authorization paradigm used in typegraphs is [policy based access control](/docs/reference/policies#policy-based-access-control-pbac). + The primary authorization paradigm used in typegraphs is [policy-based access control](/docs/reference/policies#policy-based-access-control-pbac).
Line range hint
65-65: Add a comma for clarity.- the recommended way for writing policies today and the following example demonstrates how. + the recommended way for writing policies today, and the following example demonstrates how.
Line range hint
93-95: Avoid repetitive sentence beginnings.Consider rewording the sentences to avoid starting three successive sentences with "If".
- If any one of attached policy returns `true`, the request immediately gains access. - If a policy returns `false`, the request is immediately denied access. - If the policy means to defer decision to other attached policies, it can return null instead. + If any one of the attached policies returns `true`, the request immediately gains access. A policy returning `false` will immediately deny access. To defer the decision to other attached policies, a policy can return `null` instead.
Line range hint
99-102: Fix loose punctuation marks.Ensure consistent punctuation for list items.
- `Policy.public`: allow any request. - `Policy.internal`: allow requests originating from within typegraph like custom functions. - `Policy.on`: use different policies depending on request effect. Useful for policy shared across many materalizers. - `Policy.context`: generate a policy using a simple pattern matching on context object fields. + `Policy.public`: allow any request. + `Policy.internal`: allow requests originating from within typegraph, like custom functions. + `Policy.on`: use different policies depending on request effect. Useful for policies shared across many materalizers. + `Policy.context`: generate a policy using a simple pattern matching on context object fields.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #725 +/- ##
==========================================
+ Coverage 73.52% 74.05% +0.52%
==========================================
Files 120 120
Lines 14142 13777 -365
Branches 1416 1407 -9
==========================================
- Hits 10398 10202 -196
+ Misses 3717 3549 -168
+ Partials 27 26 -1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 18
Out of diff range and nitpick comments (2)
website/docs/guides/rest/index.mdx (1)
Line range hint
25-25: Add a hyphen in "todo".- {/* todo: link to the expample's redoc*/} + {/* to-do: link to the example's redoc*/}website/docs/reference/runtimes/graphql/index.mdx (1)
Line range hint
13-15: Fix the unpaired quotation marks in therequirestatements.- python={require("../../../../../examples/typegraphs/graphql.py")} - typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} - query={require("./graphql.graphql")} + python={require("!!code-loader!../../../../../examples/typegraphs/graphql.py")} + typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} + query={require("!!code-loader!./graphql.graphql")}
There was a problem hiding this comment.
Actionable comments posted: 17
Out of diff range and nitpick comments (1)
website/docs/reference/runtimes/graphql/index.mdx (1)
Line range hint
13-15: Fix the unpaired quotation marks in therequirestatements.- python={require("../../../../../examples/typegraphs/graphql.py")} - typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} - query={require("./graphql.graphql")} + python={require("!!code-loader!../../../../../examples/typegraphs/graphql.py")} + typescript={require("!!code-loader!../../../../../examples/typegraphs/graphql.ts")} + query={require("!!code-loader!./graphql.graphql")}
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Yohe-Am <56622350+Yohe-Am@users.noreply.github.com>
Yohe-Am
dismissed stale reviews from destifo, zifeo, and michael-0acf4
via
03e860e
Yohe-Am
force-pushed
the
docs/features-overview
branch
from
9be1c56 to
03e860e
Compare
Summary by CodeRabbit
New Features
Documentation
Bug Fixes
Refactor
SDKTabsandTabItemcomponents withTGExamplefor better code example presentation.MiniQLcomponent to handle optional properties and default settings.