chore: Create version 2.9.0 #307
Conversation
|
Note Reviews pausedUse the following commands to manage reviews:
📝 WalkthroughWalkthroughA comprehensive set of documentation files for Serverpod version 2.9.0 has been added, covering tutorials, conceptual guides, deployment strategies, upgrade instructions, tool references, and contribution guidelines. The changes introduce detailed markdown documents, configuration JSON files for documentation structure, and a new sidebar and version entry. No code or API implementations are modified; all changes are documentation-focused. Changes
Sequence Diagram(s)No sequence diagrams generated, as all changes are documentation and configuration additions without new or modified code control flow. Possibly related PRs
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@coderabbitai ignore |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🧹 Nitpick comments (177)
versioned_docs/version-2.9.0/04-support.md (1)
27-31: Surround lists with blank linesMarkdown lists should be preceded and followed by blank lines to satisfy MD032. Add a blank line before line 28 and after line 31:
27 Stay connected with our video content! We regularly publish videos on YouTube covering: + 28-31 - Announcements of major new features - Step-by-step tutorials - Tips and best practices - Community highlights +versioned_docs/version-2.9.0/10-contribute.md (1)
13-13: Use correct preposition in overview sentenceReplace "provides a good overview over work in progress" with "provides a good overview of work in progress" for grammatical accuracy:
- ...provides a good overview over work in progress... + ...provides a good overview of work in progress...versioned_docs/version-2.9.0/07-deployments/_category_.json (1)
1-3: Explicit collapse behavior recommended.
Unlike the other categories, this file omits thecollapsedproperty and relies on the default. For clarity and consistency, consider adding it (e.g., collapsed: true):{ "label": "🚢 Deploying Serverpod", + "collapsed": true }versioned_docs/version-2.9.0/09-tools/_category_.json (2)
1-4: Inconsistent indentation: unify to two spaces.
The keys are indented with 4 spaces while the closing brace uses 2 spaces. Align all keys to 2-space indentation and place the closing brace at column 1 to match repository style.
5-5: Remove extraneous blank line.
Ensure only a single newline at EOF without extra blank lines.versioned_docs/version-2.9.0/06-concepts/11-authentication/_category_.json (1)
1-4: Inconsistent indentation: unify to two spaces.
Keys are indented with 4 spaces but the closing brace has 2. Standardize on 2-space indentation and align braces consistently.versioned_docs/version-2.9.0/05-tutorials/03-guides/_category_.json (1)
1-5: Trim trailing blank line.
There's an extra blank line at line 5. Remove it and ensure only one newline at EOF.versioned_docs/version-2.9.0/05-tutorials/02-tutorials/_category_.json (1)
1-5: Remove extra blank line at EOF.
Line 5 is an unnecessary blank—trim it to maintain consistency across category files.versioned_sidebars/version-2.9.0-sidebars.json (1)
7-11: Consistency of external link label
Verify that using the "📝" emoji aligns with other sidebars’ styling. Also confirm external links open as expected (Docusaurus handlestarget="_blank"by default).versioned_docs/version-2.9.0/05-tutorials/02-tutorials/01-fundamentals.md (2)
1-4: Add YAML frontmatter for sidebar labeling
To ensure a clear entry in the sidebar, consider adding frontmatter such as:--- sidebar_label: Backend Fundamentals ---
5-5: Improve readability of embed markup
Break the<div>and<iframe>onto multiple lines for maintainability (e.g., one attribute per line).versioned_docs/version-2.9.0/08-upgrading/01-upgrade-from-mini.md (2)
1-4: Inconsistent Naming in Heading
The title reads “Upgrade from Mini to full”. For clarity and consistency, consider:# Upgrade from Serverpod Mini to Full Serverpod
7-9: Use consistent code fence language
The block is taggedbashbut contains a simple shell command. For consistency with other docs, you might prefer:- ```bash + ```shell serverpod create .</blockquote></details> <details> <summary>versioned_docs/version-2.9.0/09-tools/02-lsp.md (2)</summary><blockquote> `1-1`: **Title Casing Consistency** Change the section header to title case: ```md # LSP Server
7-9: Remove shell prompt for copy-paste
Strip the leading$so users can copy-paste the command directly:- $ serverpod language-server + serverpod language-serverversioned_docs/version-2.9.0/05-tutorials/01-academy.md (2)
2-2: Emoji in sidebar label
Confirm that the🏫emoji insidebar_labelmatches your project’s style guidelines. If not, consider a text-only label.
11-17: Consistent list punctuation
Your bullet items mix phrasing without consistent end punctuation. Standardize by either adding a period to every item or removing all trailing punctuation.versioned_docs/version-2.9.0/05-tutorials/02-tutorials/03-ai-and-rag.md (2)
3-3: Improve sentence clarity and tense consistency
“We build a practical example where you can chat with…” reads awkwardly and mixes tenses. Consider:We will build a practical example that lets you chat with the Flutter and Serverpod documentation, pulling in data from official docs, issues, and discussions on GitHub.
5-5: Normalize embed HTML for MDX compliance
Using React-style props in a.mdfile may break rendering. Either rename to.mdxor convert to standard HTML attributes. For example:-<div style={{ position : 'relative', paddingBottom : '56.25%', height : '0' }}><iframe style={{ position : 'absolute', top : '0', left : '0', width : '100%', height : '100%' }} width="560" height="315" src="https://www.youtube-nocookie.com/embed/NJ9H1kmwhuE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div> +<div style="position: relative; padding-bottom: 56.25%; height: 0px;"> + <iframe + style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;" + width="560" + height="315" + src="https://www.youtube-nocookie.com/embed/NJ9H1kmwhuE" + title="YouTube video player" + frameBorder="0" + allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" + allowFullScreen> + </iframe> +</div>versioned_docs/version-2.9.0/05-tutorials/03-guides/04-authentication.md (1)
5-8: Ensure list item consistency and hyphenation
- Add a trailing period to the last bullet for uniform punctuation.
- Standardize “Sign in” vs. “Sign-In” (use “Sign-In”).
Example diff:
- - __[Google Sign in](...)__: We walk you through... + - __[Google Sign-In](...)__: We walk you through... ... - - __[Sign in with Apple](...)__: Add Sign in with Apple to your app + - __[Sign-In with Apple](...)__: Add Sign-In with Apple to your app.versioned_docs/version-2.9.0/09-tools/01-insights.md (1)
9-10: Correct casing of “macOS”
The official spelling is lowercase “macOS.”-| App version | MacOS | Windows | +| App version | macOS | Windows |versioned_docs/version-2.9.0/07-deployments/06-community-supported-deployments.md (1)
7-7: Clarify Docker Compose reference and comma usage
- Change “Docker-Compose” → “Docker Compose” (official name).
- Add a comma after “files” for clarity.
-[serverpod_vps](...) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. +[serverpod_vps](...) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker Compose. The CLI creates all required files, and the detailed step-by-step guide will help you get your server up and running in no time.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/06-modules.md (3)
3-4: Add missing comma after introductory clause
Insert a comma after “modules” to improve readability.-Serverpod [modules](../../10-modules) usually come with... +Serverpod [modules](../../10-modules), usually come with...
5-6: Correct comma splice and verb form
- Add comma after “modules.”
- Use “set up” (verb) instead of “setup” (noun).
-Since you do not directly control the models inside the modules it is recommended to create a so-called "bridge" table/model linking the module's model to your own. +Since you do not directly control the models inside the modules, it is recommended to create a so-called "bridge" table/model linking the module's model to your own. This can be done in the same way we normally would set up a one-to-one relation.
33-33: Use Oxford comma in list of relation links
Add a comma before “and [self-relations]” for consistent list formatting.-It is now possible to make any other relation to our model as described in [one-to-one](./one-to-one), [one-to-many](./one-to-many) and [many-to-many](./many-to-many) and [self-relations](./self-relations). +It is now possible to make any other relation to our model as described in [one-to-one](./one-to-one), [one-to-many](./one-to-many), [many-to-many](./many-to-many), and [self-relations](./self-relations).versioned_docs/version-2.9.0/06-concepts/13-health-checks.md (1)
3-3: Wrap database table names in code formatting
The table names should be in inline code style for clarity and consistency.- The metrics are stored in the database every minute in the serverpod_health_metric and serverpod_health_connection_info tables. + The metrics are stored in the database every minute in the `serverpod_health_metric` and `serverpod_health_connection_info` tables.versioned_docs/version-2.9.0/06-concepts/11-authentication/03-working-with-users.md (2)
3-3: Use “ID” for consistency
Capitalize “ID” to match common naming (and back-tick style if desired).- retrieve the id of a signed-in user through the session object. + retrieve the ID of a signed-in user through the session object.
27-27: Improve image alt text
The alt text should describe the UI component rather than the file name.-  + versioned_docs/version-2.9.0/06-concepts/06-database/08-sort.md (1)
14-14: Split into two sentences for clarity
Avoid comma splices and improve readability.- By default the order is set to ascending, this can be changed to descending by setting the param `orderDescending: true`. + By default, the order is set to ascending. You can change it to descending by specifying the `orderDescending: true` parameter.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/05-referential-actions.md (1)
27-33: Avoid repetitive sentence starts
Consider rephrasing the second “If” to improve flow.- If the relation is defined as an [id relation](one-to-one#with-an-id-field), the default behavior is `NoAction` for onUpdate and `Cascade` for onDelete. + For id relations, the default behavior is `NoAction` for onUpdate and `Cascade` for onDelete.versioned_docs/version-2.9.0/08-upgrading/05-upgrade-to-pgvector.md (1)
80-80: Fix subject-verb agreement in tip
Change “instructions is” to “instructions are” for correct grammar.-If the cloud provider instructions is to run a `CREATE EXTENSION vector;` command, you can skip this step as Serverpod will handle it automatically during migration. +If the cloud provider instructions are to run a `CREATE EXTENSION vector;` command, you can skip this step as Serverpod will handle it automatically during migration.versioned_docs/version-2.9.0/01-get-started/04-deployment.md (1)
17-21: Improve readability by adding missing comma and hyphen
Insert a comma after “By default” and hyphenate “built-in” for proper style.-By default Serverpod is active on three ports: +By default, Serverpod is active on three ports: - **8082**: The built in webserver is running on this port. +**8082**: The built-in webserver is running on this port.versioned_docs/version-2.9.0/06-concepts/19-testing/03-advanced-examples.md (1)
22-22: Fix “e.g.” punctuation
Include the period and comma after “e.g” for correct abbreviation formatting.-if such a module depends on a `Session` object (e.g to interact with the database), then the `withServerpod` helper can still be used and the second `endpoint` argument can simply be ignored: +if such a module depends on a `Session` object (e.g., to interact with the database), then the `withServerpod` helper can still be used and the second `endpoint` argument can simply be ignored:versioned_docs/version-2.9.0/06-concepts/19-testing/04-best-practises.md (2)
10-10: Remove redundant “additional” for clarity
Streamline the sentence by dropping “additional.”-Adding an additional import is just unnecessary noise and will likely also be flagged as duplicated imports by the Dart linter. +Adding an import is unnecessary noise and will likely be flagged as a duplicate by the Dart linter.
71-71: Add missing comma before “and”
Separate the independent clauses with a comma.-Calling endpoint methods directly would circumvent that and the code would not behave like production code. +Calling endpoint methods directly would circumvent that, and the code would not behave like production code.versioned_docs/version-2.9.0/06-concepts/06-database/10-raw-access.md (1)
58-58: Add missing comma for clarity in parameter description
A comma after “query” improves readability in the Named parameters bullet.-* **Named parameters:** Use `@` to denote named parameters in your query and pass a `Map` of parameter names and values. +* **Named parameters:** Use `@` to denote named parameters in your query, and pass a `Map` of parameter names and values.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/02-one-to-many.md (2)
9-9: Insert comma after introductory clause
A comma after “examples” clarifies the sentence.- In the following examples we show how to configure a 1:n relationship between `Company` and `Employee`. + In the following examples, we show how to configure a 1:n relationship between `Company` and `Employee`.
34-34: Add comma before dependent clause
Including a comma after “companies” improves the flow of the sentence.- When fetching companies it now becomes possible to include any or all employees in the query. + When fetching companies, it now becomes possible to include any or all employees in the query.versioned_docs/version-2.9.0/06-concepts/04-exceptions.md (1)
56-56: Clarify clause with an additional comma
Insert comma after “models” to separate the comparative clause.- Serverpod allows you to specify default values for fields in exceptions, similar to how it's done in models using the `default` and `defaultModel` keywords. + Serverpod allows you to specify default values for fields in exceptions, similar to how it's done in models, using the `default` and `defaultModel` keywords.versioned_docs/version-2.9.0/06-concepts/10-modules.md (2)
84-90: Vary phrasing to reduce repetition
The command description “useflutter createto create” repeats “create” twice; consider “run” or “generate.”- If you also want to add custom Flutter code, use `flutter create --template package my_module_flutter` + If you also want to add custom Flutter code, run `flutter create --template package my_module_flutter`
90-94: Refine phrasing for consistency
Consider replacing “most likely want to import” with “can import” and “created” with “generated” for clarity.- In your Flutter package, you most likely want to import the client libraries created by `serverpod create`. + In your Flutter package, you can import the client libraries generated by `serverpod create`.versioned_docs/version-2.9.0/06-concepts/06-database/09-pagination.md (4)
16-16: Add comma after “example”
A comma improves readability in the “In the example” sentence.- In the example we fetch the first 10 companies. + In the example, we fetch the first 10 companies.
30-30: Insert comma for introductory clause
Place a comma after “example” to set off the clause.- In the example we skip the first 30 rows and fetch the 31st to 40th company. + In the example, we skip the first 30 rows and fetch the 31st to 40th company.
48-48: Add comma after “example”
Consistently separate the introductory phrase with a comma.- In the example we fetch the third page of companies, with 10 companies per page. + In the example, we fetch the third page of companies, with 10 companies per page.
52-52: Reduce intensifier for conciseness
Consider removing “very” to tighten the recommendation.- Be aware that while `offset` can help in pagination, it may not be the most efficient way for very large datasets. + Be aware that while `offset` can help in pagination, it may not be the most efficient way for large datasets.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/03-many-to-many.md (5)
3-3: Fix verb agreement in the first sentence.Change "relationships describes" to "relationships describe" to match the plural subject.
15-15: Add missing comma and use the correct article before 'n:m'.Change to:
"In the following examples, we show how to configure an n:m relationship..."
19-19: Add comma before the coordinating conjunction.Insert a comma before "but":
"...Enrollmenttable, but no direct relationship..."
39-39: Clarify phrasing for table count.Replace "many tables" with "two tables" to accurately describe the context.
58-58: Add missing comma after introductory clause.Change to:
"If omitted, a student would be allowed..."versioned_docs/version-2.9.0/06-concepts/06-database/02-models.md (8)
3-3: Refine introductory phrasing.Consider simplifying:
"You can map serializable models to tables in your database by adding thetablekey to your YAML file."
20-20: Hyphenate 'Non-persistent'.Change section heading to:
"### Non-persistent fields"
35-35: Capitalize 'Dart' and clean up slash spacing.Consider:
"Storing a field with a primitive/core Dart type will be handled as its respective type."
44-44: Simplify wording.Replace "multiple different tables" with "multiple tables" for conciseness.
55-55: Add comma before 'see'.Change to:
"For a complete guide on how to work with relations, see the relation section."
59-60: Fix grammar in 'have always been'.Change to:
"...the id field will still be created with typeint, as it has always been."
86-86: Capitalize 'UUID' in subheading.Change "#### Default Uuid model value" to "#### Default UUID model value".
97-97: Add comma after 'assigned'.Change to:
"Since an id is always assigned, theidfield can be non-nullable."versioned_docs/version-2.9.0/07-deployments/05-general.md (3)
11-11: Replace semicolon with colon for clarity.Change to:
"...depending on which mode the server is running:development,staging, orproduction."
19-19: Add missing comma after 'Fargate'.Change to:
"...using something like AWS Fargate, it's hard..."
43-43: Add comma after 'option'.Change to:
"Running Serverpod through a Docker container is often the best option, as it provides..."versioned_docs/version-2.9.0/06-concepts/09-logging.md (2)
20-20: Add comma before 'depending on'.Change to:
"...filter out messages, depending on the server's runtime settings."
61-61: Remove extra space before link.Change to:
"You can use the companion app Serverpod Insights to read..."versioned_docs/version-2.9.0/08-upgrading/04-upgrade-to-two-point-two.md (3)
3-3: Add comma after introductory clause.Change to:
"For new projects, they are configured by default, but existing projects..."
7-7: Hyphenate 'non-mini'.Change to:
"For existing non-mini projects, a few extra things need..."
15-15: Add comma and refine phrasing for brevity.Change to:
"Without this key, the test tools file is not generated. With the above config, the location..."versioned_docs/version-2.9.0/06-concepts/12-file-uploads.md (3)
3-3: Add comma before 'but' for clarityInsert a comma before "but" to improve readability.
Apply this diff:
- This works well for testing but may not be performant in larger-scale applications. + This works well for testing, but may not be performant in larger-scale applications.
35-36: Remove redundancy and tighten phrasingRefine the sentence to avoid tautology and unnecessary words:
- using a `Stream` is better because not all of the data must be held in RAM memory. Finally, you should verify the upload with the server. + using a `Stream` is better because not all of the data must be held in RAM. Finally, verify the upload with the server.
58-58: Correct article before URLUse "a" instead of "an" before "URL":
- accessible to the world through an URL. + accessible to the world through a URL.versioned_docs/version-2.9.0/06-concepts/16-server-events.md (2)
2-3: Add missing 'the' for grammatical correctnessPrepend "the" before "Serverpod framework":
- Serverpod framework comes with a built-in event messaging system. + The Serverpod framework comes with a built-in event messaging system.
28-29: Fix missing verb in descriptionMake the sentence active by adding "is" and "to":
- In the example above, the message published on the `user_updates` channel. + In the example above, the message is published to the `user_updates` channel.versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/03-apple.md (4)
8-9: Standardize macOS casingUse the correct platform name "macOS":
- Right now, we have official support for iOS and MacOS for Sign in with Apple. + Right now, we have official support for iOS and macOS for Sign in with Apple.
31-32: Standardize macOS casingUpdate "MacOS" to "macOS":
- Enable the sign-in with Apple capability in your Xcode project, this is the same type of configuration for your iOS and MacOS projects respectively. + Enable the Sign in with Apple capability in your Xcode project; this is the same configuration for your iOS and macOS targets.
39-41: Add missing article for clarityPrepend "The" before the package name:
- `serverpod_auth_apple_flutter` package comes with the widget `SignInWithAppleButton` that renders a nice Sign in with Apple button and triggers the native sign-in UI. + The `serverpod_auth_apple_flutter` package comes with the widget `SignInWithAppleButton` that renders a nice Sign in with Apple button and triggers the native sign-in UI.
1-1: Consider expanding the title for clarity (optional)Change the main heading to explicitly "Sign in with Apple" to match other provider docs:
- # Apple + # Sign in with Appleversioned_docs/version-2.9.0/01-get-started/01-creating-endpoints.md (1)
7-7: Refine description of API callReplace "talk with" to "call" for precision:
- Your server will talk with Google's Gemini API to make this magic happen. + Your server will call Google's Gemini API to make this magic happen.versioned_docs/version-2.9.0/06-concepts/05-sessions.md (1)
11-14: Clarify Dart type casting exampleAssign the casted session to a new variable so the cast applies:
- ```dart - session as MethodCallSession; - var ipAddress = session.httpRequest.remoteIpAddress; - ``` + ```dart + var methodSession = session as MethodCallSession; + var ipAddress = methodSession.httpRequest.remoteIpAddress; + ```versioned_docs/version-2.9.0/06-concepts/14-scheduling.md (7)
3-3: Add missing comma after introductory phrase
Improve readability by adding a comma after "Serverpod".- With Serverpod you can schedule future work with the `future call` feature. + With Serverpod, you can schedule future work with the `future call` feature.
5-5: Replace "not able" with "unable" for conciseness
Use "unable" to tighten phrasing.- … It is your responsibility to schedule a new future call if the work was not able to complete. + … It is your responsibility to schedule a new future call if the work was unable to complete.
9-9: Insert comma before clause
Separate clauses for clarity by adding a comma after "params".- The method takes two params the first being the [`Session`](sessions) object … + The method takes two params, the first being the [`Session`](sessions) object …
26-26: Add comma to separate dependent clause
Improve flow by inserting a comma before "you have to".- To let your Server get access to the future call you have to register it in the main run method… + To let your Server get access to the future call, you have to register it in the main run method…
44-44: Use "can now" instead of "are now able to"
Shorten phrasing for a more direct tone.- You are now able to register a future call to be invoked in the future … + You can now register a future call to be invoked in the future …
70-70: Add comma after introductory clause
Separate the introductory phrase with a comma.- When registering a future call it is also possible to give it an `identifier` … + When registering a future call, it is also possible to give it an `identifier` …
113-115: Remove redundant "of" for conciseness
Drop the extra "of" to tighten the description.- … you might want to tune this value to ensure that not all of the server's resources are allocated … + … you might want to tune this value to ensure that not all the server's resources are allocated …versioned_docs/version-2.9.0/06-concepts/06-database/08-transactions.md (4)
22-22: Add missing comma after "example"
Insert a comma to separate the introductory phrase.- In the example we insert a company and an employee in the same transaction. + In the example, we insert a company and an employee in the same transaction.
46-46: Add comma after "example"
Improve clarity by separating clauses.- In the example the isolation level is set to `IsolationLevel.serializable`. + In the example, the isolation level is set to `IsolationLevel.serializable`.
54-54: Add comma before participial phrase
Separate the main clause and participial phrase.- … was executed giving a consistent view of the database. + … was executed, giving a consistent view of the database.
117-117: Add comma after "inserted"
Improve sentence flow by adding a comma.- After the company is inserted the first savepoint is released, which renders … + After the company is inserted, the first savepoint is released, which renders …versioned_docs/version-2.9.0/serverpod-mini.md (2)
8-8: Reduce repetitive sentence beginnings
Several sentences start with "Serverpod". Consider rephrasing one to improve readability and avoid repetition.
54-54: Use "talk to" instead of "talk with"
"Talk to" is more idiomatic for client-server communication.- … a sample Flutter app, all hooked up to talk with your server. + … a sample Flutter app, all hooked up to talk to your server.versioned_docs/version-2.9.0/06-concepts/06-database/01-connection.md (4)
3-3: Add missing comma after introductory phrase
Improve readability by adding a comma after "Serverpod".- In Serverpod the connection details and password for the database are stored inside the `config` directory… + In Serverpod, the connection details and password for the database are stored inside the `config` directory…
10-10: Add comma after introductory clause
Separate clauses for clarity.- For your development build you can find the connection details in the `config/development.yaml` file. + For your development build, you can find the connection details in the `config/development.yaml` file.
90-90: Simplify "take into consideration"
Consider replacing with "consider" for brevity.- There are a few things you need to take into consideration: + There are a few things you need to consider:
112-112: Add comma before coordinating conjunction
Insert a comma before "and" to separate independent clauses.- … Cloud Run and changing the database host string to the Cloud SQL public IP. + … Cloud Run, and changing the database host string to the Cloud SQL public IP.versioned_docs/version-2.9.0/01-get-started/03-working-with-the-database.md (3)
53-53: Refine wording for clarity.Replace "giving us access" with "providing access" to improve precision.
185-185: Correct verb choice.Use "made any changes" instead of "done any changes" for natural phrasing.
198-198: Fix gerund usage.Change "suggest to creating" to "suggest creating" to correct the gerund form.
versioned_docs/version-2.9.0/06-concepts/06-database/07-relation-queries.md (3)
3-3: Add comma after introductory phrase.Use "In SQL, this is often achieved…" for correct punctuation.
19-19: Correct grammar and article use.Change "return a employee" to "returns an employee".
39-39: Insert comma before conjunction.Add a comma before "but" for compound sentence clarity.
versioned_docs/version-2.9.0/06-concepts/17-backward-compatibility.md (3)
3-3: Add comma after conjunctive adverb.Insert a comma after "Therefore" in "Therefore, it may be essential…" for proper style.
13-13: Use correct compound noun.Replace "sub-class" with "subclass".
42-42: Add comma for conjunctive adverb.Insert a comma after "Additionally" in "Additionally, all the other…" for correct punctuation.
versioned_docs/version-2.9.0/06-concepts/07-configuration.md (1)
7-7: Insert comma before conjunction.Add a comma before "but" in "…configurations, but both can be used…" for correct compound sentence punctuation.
versioned_docs/version-2.9.0/06-concepts/03-serialization.md (2)
94-98: Prefer concise phrasing
Change "You are now able to use this class…" to "You can now use this class…" for a more direct tone.
158-158: Clarify placeholder usage
The.......placeholder in the code block is ambiguous. Replace it with a clear comment (e.g.,// ...) or concrete example to indicate omitted implementation.versioned_docs/version-2.9.0/07-deployments/01-deployment-strategy.md (3)
11-12: Use hyphens for compound adjectives
Replace "real time communication" with "real-time communication" and "cost efficient" with "cost-efficient" to follow standard style.
28-29: Add missing comma for clarity
Insert a comma before "which" in "...on your servers, which can cut down costs..." to improve readability.
29-29: Use appropriate quantifier
Change "a fair amount of users" to "a fair number of users" since "users" is countable.versioned_docs/version-2.9.0/02-overview.md (3)
25-25: Refine verb choice
Consider replacing "gives access to" with "provides access to" in the description ofSessionfor a more consistent tone.
50-51: Improve preposition usage
Replace "talking with the database" with "talking to the database" or "interacting with the database" for clearer phrasing.
80-82: Reduce wordiness
Simplify "insert a new record" to "insert a record" to keep the explanation concise.versioned_docs/version-2.9.0/06-concepts/11-authentication/02-basics.md (2)
5-6: Fix typo in phrase
Remove the extra 'a' in "whenever you a referring to a user" → "whenever you are referring to a user".
42-43: Correct preposition
Change "for an endpoint" to "to an endpoint" in the sentence "To restrict access to an endpoint".versioned_docs/version-2.9.0/06-concepts/06-database/04-indexing.md (2)
33-35: Add missing comma
Insert a comma after "for example" → "for example, if you want to make sure that no two companies have the same name."
63-64: Insert missing comma
Add a comma after "If no type is specified" → "If no type is specified, the default isbtree."versioned_docs/version-2.9.0/06-concepts/06-database/06-filter.md (1)
3-3: Grammar: add missing article.
In the sentence "used as argument", insert "an" to read "used as an argument".versioned_docs/version-2.9.0/07-deployments/04-deploying-to-aws.md (1)
80-87: Fix list numbering in "Configure Dart Version".
In the "Configure Dart Version" section, two list items are both numbered "1."; update the second to "2." for proper sequence.versioned_docs/version-2.9.0/06-concepts/11-authentication/05-custom-overrides.md (1)
3-3: Grammar: add missing comma.
Insert a comma after "package" in "It is recommended to use theserverpod_authpackage, but if you have special requirements...".versioned_docs/version-2.9.0/06-concepts/19-testing/02-the-basics.md (4)
83-86: Suggestion: Add missing comma after introductory phrase.
In the info block, prepend “By default,” with a comma for readability.
131-133: Nitpick: Inconsistent type casing.
The default valueServerpodRunmode.testshould beServerpodRunMode.testto match the enum name.
156-160: Nitpick: Hyphenate compound adjectives.
Use “top-level” and “set-up” to clarify phrases like “top level transaction” and “set up the test group.”
200-203: Nitpick: Correct possessive form.
Change “each others database state” to “each other’s database state.”versioned_docs/version-2.9.0/07-deployments/02-deploying-to-gce-terraform.md (4)
3-3: Nitpick: Missing comma.
Consider adding a comma after “easy” in “Google Cloud Engine easy, using GitHub, Terraform, and Docker containers.”
78-78: Nitpick: Extra whitespace.
Remove the double space before the parenthesis in “Artifact Registry API (artifactregistry.googleapis.com)”.
268-268: Nitpick: Missing comma after introductory clause.
Add a comma after “Once your code is uploaded to the Artifact Registry,” for clarity.
268-269: Nitpick: Term consistency.
Use “autoscaling” (or “auto-scaling”) instead of “auto scaling.”versioned_docs/version-2.9.0/06-concepts/11-authentication/01-setup.md (2)
3-3: Nitpick: Missing comma.
Add a comma after “It is possible to build a custom authentication implementation,” to separate clauses.
52-54: Nitpick: Add comma after introductory adverb.
Change “First you have to create a new migration…” to “First, you have to create a new migration…”.versioned_docs/version-2.9.0/08-upgrading/02-upgrade-to-one-point-two.md (3)
9-11: Nitpick: Typo in possessive pronoun.
Change “To update you Serverpod command line interface” to “To update your Serverpod command line interface.”
27-28: Nitpick: Capitalize technology name.
Use “Dart” instead of “dart” in the phrase “This update has bumped the minimum required Dart version to…”
183-185: Nitpick: Hyphenate adjective.
Use “up-to-date” instead of “up to date” to describe version compatibility.versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/06-custom-providers.md (1)
42-42: Nitpick: Missing comma.
Add a comma after “If other identification methods are required,” in the sentence introducing custom identification methods.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/04-self-relations.md (2)
29-33: Add comma after introductory clause.
In the One-to-many section, add a comma after “relation” for grammatical correctness.
Suggestion:-In a one-to-many self-referenced relation there is one object field connected to a list field. +In a one-to-many self-referenced relation, there is one object field connected to a list field.
36-38: Split or adjust comma splice.
The sentence “The fieldmotherId: int?is injected into the dart class, the field is nullable since we marked the fieldmotheras anoptionalrelation.” contains a comma splice. Consider splitting into two sentences or using a semicolon.versioned_docs/version-2.9.0/06-concepts/18-webserver.md (1)
3-4: Consider removing weak intensifier.
Replace “very easy” with a stronger adverb for clarity.- This makes it very easy to share data for applications that need both an app and traditional web pages. + This makes it straightforward to share data for applications that need both an app and traditional web pages.versioned_docs/version-2.9.0/06-concepts/06-database/11-migrations.md (8)
11-11: Add missing comma for clarity.Insert a comma after “false” to improve readability:
- When this flag is set to false the generated migrations will not define any SQL code… + When this flag is set to false, the generated migrations will not define any SQL code…
21-21: Add comma after introductory clause.Add a comma after “Serverpod” for clarity:
- to then be managed by Serverpod you first need to set this flag to `true`. + to then be managed by Serverpod, you first need to set this flag to `true`.
28-28: Insert comma to separate clauses.Place a comma after “migration” in the command description:
- To create a migration navigate to your project's `server` package directory… + To create a migration, navigate to your project's `server` package directory…
36-36: Add comma for readability.Insert a comma after “exists”:
- If no previous migration exists it will create a migration… + If no previous migration exists, it will create a migration…
97-97: Add missing comma in complex sentence.Insert a comma after “sequence” to improve flow:
- applied as part of the startup sequence and the framework… + applied as part of the startup sequence, and the framework…
130-130: Add comma before subordinate clause.Place a comma after “tables”:
- To preserve manually created or managed tables the [repair migration]… + To preserve manually created or managed tables, the [repair migration]…
194-194: Insert comma for clarity.Add a comma after “sequence”:
- applied as part of the startup sequence and the framework asserts… + applied as part of the startup sequence, and the framework asserts…
210-210: Add comma after introductory phrase.Insert a comma after “Utilizing repair migrations”:
- Utilizing repair migrations it is easy to roll back… + Utilizing repair migrations, it is easy to roll back…versioned_docs/version-2.9.0/01-get-started/02-models-and-data.md (1)
138-138: Add missing comma for readability.Insert a comma after “model”:
- Now that we have created the `Recipe` model we can use it… + Now that we have created the `Recipe` model, we can use it…versioned_docs/version-2.9.0/06-concepts/19-testing/01-get-started.md (2)
22-22: Insert missing comma.Add a comma after “config”:
- With the above config the location of the test tools file… + With the above config, the location of the test tools file…
213-213: Add comma before transition.Insert a comma after “generated”:
- The default location for the generated file exports… + The default location for the generated file, exports…versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/02-google.md (6)
17-17: Capitalize “Google.”“Google” is a proper noun:
- you need a google cloud project. + you need a Google Cloud project.
21-21: Add comma for clarity.Insert a comma after “Serverpod”:
- use the authentication method in Serverpod we have to enable… + use the authentication method in Serverpod, we have to enable…
39-39: Capitalize & comma.“Google Cloud Console” and add comma after clause:
- Create the server credentials in the google cloud console. + Create the server credentials in the Google Cloud Console, then download…
65-65: Add comma in compound sentence.Insert a comma after “plist file”:
- Then download the `plist` file rename it to… + Then download the `plist` file, rename it to…
81-81: Add comma before dependent clause.Insert a comma after “signed in”:
- after the user has signed in we have to add… + after the user has signed in, we have to add…
114-114: Insert missing article.Add “the” before “debug SHA-1 hash”:
- you can get the debug SHA-1 hash by running… + you can get the debug SHA-1 hash by running…versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/05-firebase.md (3)
13-13: Insert missing comma.Add a comma after “project”:
- To create a new key go to the [Firebase console]… + To create a new key, go to the [Firebase console]…
17-17: Add comma after subordinate clause.Insert a comma after “here”:
- if this file is corrupt or if the name does not follow the convention here the authentication… + if this file is corrupt or if the name does not follow the convention here, the authentication…
86-86: Refine wording in documentation.Replace “talk with” to “communicate with” for more formal tone:
- the Serverpod client you use to talk with the server… + the Serverpod client you use to communicate with the server…versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/01-one-to-one.md (5)
3-3: Fix comma splice and improve sentence clarity.Change the comma between independent clauses to a semicolon or period:
- One-to-one (1:1) relationships represent a unique association between two entities, there is at most one model... + One-to-one (1:1) relationships represent a unique association between two entities; there is at most one model...
7-7: Add missing comma after introductory phrase.Insert a comma after “In the following examples” for readability:
- In the following examples we show how to configure a 1:1 relationship... + In the following examples, we show how to configure a 1:1 relationship...
104-104: Simplify phrasing to reduce wordiness.Replace “in conjunction with” with “with”:
- the `field` keyword cannot be used in conjunction with the `optional` keyword. + the `field` keyword cannot be used with the `optional` keyword.
134-134: Use “can” instead of “are able to.”Replace “You are able to define…” with “You can define…”:
- You are able to define as many independent relations as you wish... + You can define as many independent relations as you wish...
191-191: Add comma after dependent clause.Insert a comma for clarity:
- When the relationship is defined on both sides it is **required** to specify the `field` keyword. + When the relationship is defined on both sides, it is **required** to specify the `field` keyword.versioned_docs/version-2.9.0/06-concepts/01-working-with-endpoints.md (3)
15-15: Add missing comma after introductory clause.- To generate the client-side code run `serverpod generate` in the home directory... + To generate the client-side code, run `serverpod generate` in the home directory...
31-32: Correct example client URL.Remove the
$beforelocalhostin the connection string:- var client = Client('http://$localhost:8080/') + var client = Client('http://localhost:8080/')
35-35: Use correct casing for macOS.Replace “MacOS” with “macOS”:
- ifconfig (Linux/MacOS) or `ipconfig` (Windows) + ifconfig (Linux/macOS) or `ipconfig` (Windows)versioned_docs/version-2.9.0/06-concepts/21-experimental.md (5)
16-16: Add missing comma after introductory clause.- When an experimental feature matures it is moved from `experimental` to `Serverpod` proper. + When an experimental feature matures, it is moved from `experimental` to `Serverpod` proper.
59-59: Fix pluralization.Change “field” to “fields”:
- This will generate a class with both `name` and `age` field. + This will generate a class with both `name` and `age` fields.
171-171: Simplify phrasing.Replace “in order to gain insights into the behavior of the server” with “to gain insights into server behavior”:
- implementations can react to these events in order to gain insights into the behavior of the server. + implementations can react to these events to gain insights into server behavior.
179-179: Correct grammar and phrasing.Use “cannot” and add “run” before “asynchronously”:
- handlers are typically run concurrently, can not depend on each other, and asynchronously + handlers are typically run concurrently, cannot depend on each other, and run asynchronously
182-182: Add missing comma.- If a handler throws an exception it will be logged to stderr and otherwise ignored. + If a handler throws an exception, it will be logged to stderr and otherwise ignored.versioned_docs/version-2.9.0/08-upgrading/03-upgrade-to-two.md (8)
5-5: Add missing comma after introductory clause.- If you are not using authentication at all this change does not impact you. + If you are not using authentication at all, this change does not impact you.
7-7: Add comma after dependent clause.- in your server.dart file make the following change: + in your server.dart file, make the following change:
26-26: Fix verb agreement and pluralization.- The methods `signInUser` and `signOutUser` now takes the session object as a param and is no longer available on the session object. + The methods `signInUser` and `signOutUser` now take the session object as a param and are no longer available on the session object.
64-64: Fix typo in pronoun.- Your are then responsible for creating/removing entries in this table... + You are then responsible for creating/removing entries in this table...
107-107: Add missing comma after introductory clause.- If the `authenticated` property is set on the session it effectively means there is an authenticated user making the request. + If the `authenticated` property is set on the session, it effectively means there is an authenticated user making the request.
270-270: Fix comma placement around “therefore.”- Existing migrations therefore, won't be changed by the Serverpod migration system. + Existing migrations, therefore, won't be changed by the Serverpod migration system.
276-276: Add missing comma after introductory phrase.- In most cases a good index strategy will be more important than the integer representation. + In most cases, a good index strategy will be more important than the integer representation.
349-349: Add missing comma for clarity.- simplifies the serialization process not only for general models but also significantly enhances custom serialization workflows. + simplifies the serialization process not only for general models, but also significantly enhances custom serialization workflows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (91)
versioned_docs/version-2.9.0/01-get-started/01-creating-endpoints.md(1 hunks)versioned_docs/version-2.9.0/01-get-started/02-models-and-data.md(1 hunks)versioned_docs/version-2.9.0/01-get-started/03-working-with-the-database.md(1 hunks)versioned_docs/version-2.9.0/01-get-started/04-deployment.md(1 hunks)versioned_docs/version-2.9.0/01-get-started/_category_.json(1 hunks)versioned_docs/version-2.9.0/02-overview.md(1 hunks)versioned_docs/version-2.9.0/04-support.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/01-academy.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/02-tutorials/01-fundamentals.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/02-tutorials/02-real-time-communication.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/02-tutorials/03-ai-and-rag.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/02-tutorials/_category_.json(1 hunks)versioned_docs/version-2.9.0/05-tutorials/03-guides/04-authentication.md(1 hunks)versioned_docs/version-2.9.0/05-tutorials/03-guides/_category_.json(1 hunks)versioned_docs/version-2.9.0/05-tutorials/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/01-working-with-endpoints.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/02-models.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/03-serialization.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/04-exceptions.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/05-sessions.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/01-connection.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/02-models.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/01-one-to-one.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/02-one-to-many.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/03-many-to-many.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/04-self-relations.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/05-referential-actions.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/06-modules.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/04-indexing.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/05-crud.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/06-filter.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/07-relation-queries.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/08-sort.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/08-transactions.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/09-pagination.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/10-raw-access.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/11-migrations.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/12-runtime-parameters.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/06-database/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/07-configuration.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/08-caching.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/09-logging.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/10-modules.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/01-setup.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/02-basics.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/03-working-with-users.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/01-email.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/02-google.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/03-apple.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/05-firebase.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/06-custom-providers.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/05-custom-overrides.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/11-authentication/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/12-file-uploads.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/13-health-checks.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/14-scheduling.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/15-streams.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/16-server-events.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/17-backward-compatibility.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/18-webserver.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/19-testing/01-get-started.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/19-testing/02-the-basics.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/19-testing/03-advanced-examples.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/19-testing/04-best-practises.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/19-testing/_category_.json(1 hunks)versioned_docs/version-2.9.0/06-concepts/20-security-configuration.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/21-experimental.md(1 hunks)versioned_docs/version-2.9.0/06-concepts/_category_.json(1 hunks)versioned_docs/version-2.9.0/07-deployments/01-deployment-strategy.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/02-deploying-to-gce-terraform.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/03-deploying-to-gcr-console.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/04-deploying-to-aws.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/05-general.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/06-community-supported-deployments.md(1 hunks)versioned_docs/version-2.9.0/07-deployments/_category_.json(1 hunks)versioned_docs/version-2.9.0/08-upgrading/01-upgrade-from-mini.md(1 hunks)versioned_docs/version-2.9.0/08-upgrading/02-upgrade-to-one-point-two.md(1 hunks)versioned_docs/version-2.9.0/08-upgrading/03-upgrade-to-two.md(1 hunks)versioned_docs/version-2.9.0/08-upgrading/04-upgrade-to-two-point-two.md(1 hunks)versioned_docs/version-2.9.0/08-upgrading/05-upgrade-to-pgvector.md(1 hunks)versioned_docs/version-2.9.0/08-upgrading/_category_.json(1 hunks)versioned_docs/version-2.9.0/09-tools/01-insights.md(1 hunks)versioned_docs/version-2.9.0/09-tools/02-lsp.md(1 hunks)versioned_docs/version-2.9.0/09-tools/_category_.json(1 hunks)versioned_docs/version-2.9.0/10-contribute.md(1 hunks)versioned_docs/version-2.9.0/index.md(1 hunks)versioned_docs/version-2.9.0/serverpod-mini.md(1 hunks)versioned_sidebars/version-2.9.0-sidebars.json(1 hunks)versions.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
versioned_docs/version-2.9.0/10-contribute.md
[uncategorized] ~13-~13: The preposition “of” seems more likely in this position.
Context: ...to change, but provides a good overview over work in progress and what is planned fo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
versioned_docs/version-2.9.0/06-concepts/06-database/08-sort.md
[uncategorized] ~12-~12: Possible missing comma found.
Context: ... orderBy: (t) => t.name, ); ``` In the example we fetch all companies and sort them by...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~13-~13: Did you mean: “By default,”?
Context: ...companies and sort them by their name. By default the order is set to ascending, this can...
(BY_DEFAULT_COMMA)
[grammar] ~14-~14: The verb after “to” should be in the base form as part of the to-infinitive. A verb can take many forms, but the base form is always used in the to-infinitive.
Context: ...r name. By default the order is set to ascending, this can be changed to descending by s...
(TO_NON_BASE)
[uncategorized] ~24-~24: A comma might be missing here.
Context: ... orderDescending: true, ); ``` In the example we fetch all companies and sort them by...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~26-~26: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...rByList, note that this cannot be used in conjunction with orderByandorderDescending`. ```da...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...rder(column: t.id), ], ); ``` In the example we fetch all companies and sort them by...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...erBy: (t) => t.ceo.name, ); ``` In the example we fetch all companies and sort them by...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~62-~62: A comma might be missing here.
Context: ... => t.employees.count(), ); ``` In the example we fetch all companies and sort them by...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~75-~75: Possible missing comma found.
Context: ...quals('developer'), ), ); ``` In the example we fetch all companies and sort them by...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/09-pagination.md
[uncategorized] ~16-~16: A comma might be missing here.
Context: ... session, limit: 10, ); ``` In the example we fetch the first 10 companies. ## Of...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~30-~30: A comma might be missing here.
Context: ...limit: 10, offset: 30, ); ``` In the example we skip the first 30 rows and fetch the...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...- 1) * companiesPerPage, ); ``` In the example we fetch the third page of companies, w...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~52-~52: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t may not be the most efficient way for very large datasets. Using an indexed column to fi...
(EN_WEAK_ADJECTIVE)
versioned_docs/version-2.9.0/09-tools/01-insights.md
[grammar] ~9-~9: The operating system from Apple is written “macOS”.
Context: ...wnloads | App version | MacOS ...
(MAC_OS)
versioned_docs/version-2.9.0/06-concepts/10-modules.md
[style] ~86-~86: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... and a client Dart package. If you also want to add custom Flutter code, use `flutter c...
(REP_WANT_TO_VB)
[style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...n your Flutter package, you most likely want to import the client libraries created by ...
(REP_WANT_TO_VB)
versioned_docs/version-2.9.0/06-concepts/19-testing/03-advanced-examples.md
[uncategorized] ~22-~22: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...a module depends on a Session object (e.g to interact with the database), then th...
(E_G)
[style] ~119-~119: Consider using a synonym to be more concise.
Context: ...s' available CPU cores. If the host has a lot of cores it could trigger a case where the...
(A_LOT_OF)
[uncategorized] ~119-~119: Possible missing comma found.
Context: ...ble CPU cores. If the host has a lot of cores it could trigger a case where the numbe...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ll will lazily create its own Serverpod instance which will connect to the database. Spe...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...se), sessionBuilder.build() has to be called which then triggers a database connecti...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~128-~128: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on in setUp/setUpAll instead of the top level scope: ```dart withServerpod('Given ex...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~147-~147: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...; ``` :::info This case should be rare and the above example is not a recommended ...
(COMMA_COMPOUND_SENTENCE_2)
versioned_docs/version-2.9.0/07-deployments/06-community-supported-deployments.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...r-Compose. The CLI creates all required files and the detailed step-by-step guide wil...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/09-logging.md
[uncategorized] ~20-~20: Possible missing comma found.
Context: ...og level with the message to filter out messages depending on the server's runtime setti...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~24-~24: Use “nor” with neither.
Context: ...or neither, using environment variables or configuration files. **Environment vari...
(NEITHER_NOR)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...ERVERPOD_SESSION_PERSISTENT_LOG_ENABLED`: Controls whether session logs are writt...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ... SERVERPOD_SESSION_CONSOLE_LOG_ENABLED: Controls whether session logs are outpu...
(UNLIKELY_OPENING_PUNCTUATION)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/06-modules.md
[uncategorized] ~5-~5: A comma might be missing here.
Context: ... directly control the models inside the modules it is recommended to create a so-called...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~5-~5: The word “setup” is a noun. The verb is spelled with a space.
Context: ... done in the same way we normally would setup a one-to-one relation. ```yaml class: ...
(NOUN_VERB_CONFUSION)
versioned_docs/version-2.9.0/07-deployments/05-general.md
[uncategorized] ~19-~19: A comma might be missing here.
Context: ...id. If you are using something like AWS Fargate it's hard to configure individual serve...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~19-~19: To elevate your writing, try using a synonym here.
Context: ...e using something like AWS Fargate it's hard to configure individual server ids. ::...
(HARD_TO)
[uncategorized] ~43-~43: Possible missing comma found.
Context: ...gh a Docker container is often the best option as it provides a well-defined environme...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~51-~51: Consider using a more formal alternative.
Context: ..., but you can specify verbose` to get more information during startup which can help with debu...
(MORE_INFO)
versioned_docs/version-2.9.0/serverpod-mini.md
[style] ~8-~8: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... Mini ## Serverpod or Serverpod Mini? Serverpod Mini is a lightweight version of Server...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~54-~54: The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition.
Context: ... a sample Flutter app, all hooked up to talk with your server. Run it with the flutter ...
(TALK_WITH)
[typographical] ~131-~131: It seems that a comma is missing.
Context: ...ints and methods. To call the endpoint method we just created from Flutter, just crea...
(IN_ORDER_TO_VB_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/10-raw-access.md
[uncategorized] ~58-~58: Possible missing comma found.
Context: ... @ to denote named parameters in your query and pass a Map of parameter names and...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/02-models.md
[style] ~3-~3: Consider a more expressive alternative.
Context: ...e models to tables in your database. To do this, add the table key to your yaml ...
(DO_ACHIEVE)
[grammar] ~20-~20: This expression is usually spelled with a hyphen.
Context: ...bject stored in the database. ::: ### Non persistent fields You can opt out of creating a c...
(NON_ANTI_JJ)
[uncategorized] ~55-~55: Possible missing comma found.
Context: ...or a complete guide on how to work with relations see the [relation section](relations/on...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~59-~59: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ll still be created with type int, as have always been. The following types are s...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~97-~97: A comma might be missing here.
Context: ...bject is created. Since an id is always assigned the id field can be non-nullable.
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/04-exceptions.md
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...exceptions, similar to how it's done in models using the default and defaultModel ...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/03-many-to-many.md
[uncategorized] ~9-~9: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...r a flexible and normalized approach to represent n:m relationships. Modeling the relati...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ning the relationship In the following examples we show how to configure a n:m relation...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~15-~15: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...owing examples we show how to configure a n:m relationship between Student and ...
(EN_A_VS_AN)
[uncategorized] ~58-~58: Possible missing comma found.
Context: ...nrolled in a particular course once. If omitted a student would be allowed to be enroll...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/07-configuration.md
[uncategorized] ~7-~7: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... precedence over the yaml configurations but both can be used simultaneously. The da...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~55-~55: It’s more common nowadays to write this noun as one word.
Context: ....user | - | The user name for database authentication ...
(RECOMMENDED_COMPOUNDS)
[style] ~61-~61: It’s more common nowadays to write this noun as one word.
Context: ...er | - | The user name for Redis authentication ...
(RECOMMENDED_COMPOUNDS)
[uncategorized] ~159-~159: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ter the run mode you start the server in and it needs to be placed inside the `confi...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~207-~207: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... server to connect to different services but you can also supply your secrets if you...
(COMMA_COMPOUND_SENTENCE)
[style] ~207-~207: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...es but you can also supply your secrets if you want. This file is structured with a common ...
(IF_YOU_WANT)
[uncategorized] ~228-~228: Possible missing comma found.
Context: ...ject example To configure Serverpod in Dart you simply pass an instance of the `Ser...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~260-~260: A comma might be missing here.
Context: ...e configured and no dart config file is supplied this default configuration will be used...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/index.md
[grammar] ~109-~109: Did you mean “are” or “were”?
Context: ...ver's logs and health metrics. Insights is available for Mac and Windows, but we w...
(SENT_START_NNS_IS)
[typographical] ~125-~125: It seems that a comma is missing.
Context: ...MyCounter` is not. ::: To run your new project you must first start the database from ...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~138-~138: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e, meaning it will run in the background and you can safely close the terminal windo...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~148-~148: A comma might be missing here.
Context: ...g. ::: Now that the database is up and running we can start the Serverpod server. Beca...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/11-authentication/05-custom-overrides.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...erver setup When running a custom auth integration it is up to you to build the authentica...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...u to build the authentication model and issuing auth tokens. ### Token validation The...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...thIdfield in theAuthenticationInfo` object you can link the user to a specific aut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ... you can format your scopes however you want as long as they are in a String format....
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~45-~45: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...s long as they are in a String format. Normally if you implement a JWT you would store ...
(CONJUNCTIVE_LINKING_ADVERB_COMMA_PREMIUM)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...copes inside the token. When extracting them all you have to do is convert the Strin...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~73-~73: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...nt message. See below for the different type of messages. #### Revoked authentication messages ...
(TYPE_OF_PLURAL)
[uncategorized] ~89-~89: A comma might be missing here.
Context: ...henticate/authorize the user. But as an example such an endpoint could look like the fo...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~146-~146: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...KeyManager` is not practical and should only be used for testing. A secure implement...
(ONLY_EXCLUSIVELY_STYLE)
[uncategorized] ~187-~187: Did you mean: “By default,”?
Context: ...` variable. ## Authentication schemes By default Serverpod will pass the authentication ...
(BY_DEFAULT_COMMA)
[uncategorized] ~190-~190: Possible missing comma found.
Context: ...ps the user-provided token in a basic scheme which is automatically unwrapped on the...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~192-~192: A comma might be missing here.
Context: ...tion handler described above. In other words the default transport implementation is...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~196-~196: Consider putting a comma before the abbreviation “i.e.”.
Context: ... is supported but will be automatically unwrapped i.e. decoded on the server side before being...
(IE_COMMA)
[style] ~200-~200: Consider a more concise word here.
Context: ...he AuthenticationHandler accordingly, in order to process that header value server-side. ...
(IN_ORDER_TO_PREMIUM)
[style] ~208-~208: Consider shortening or rephrasing this to strengthen your wording.
Context: ...approach to adding OAuth handling might make changes to the above code akin to the following. ...
(MAKE_CHANGES)
versioned_docs/version-2.9.0/06-concepts/14-scheduling.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: # Scheduling With Serverpod you can schedule future work with the `...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~5-~5: Consider using “unable” to avoid wordiness.
Context: ...edule a new future call if the work was not able to complete. ## Future calls Creating...
(NOT_ABLE_PREMIUM)
[uncategorized] ~5-~5: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...future call if the work was not able to complete. ## Future calls Creating a future ca...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...e invoke method. The method takes two params the first being the [Session](session...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...et your Server get access to the future call you have to register it in the main run...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~44-~44: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...'exampleFutureCall'); ... } ``` You are now able to register a future call to be invoked in...
(BE_ABLE_TO)
[uncategorized] ~70-~70: Possible missing comma found.
Context: ...need it. ::: When registering a future call it is also possible to give it an `iden...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~113-~113: Consider removing “of” to be more concise
Context: ...t to tune this value to ensure that not all of the server's resources are allocated to fut...
(ALL_OF_THE)
versioned_docs/version-2.9.0/06-concepts/16-server-events.md
[uncategorized] ~2-~2: You might be missing the article “the” here.
Context: # Server events Serverpod framework comes with a built-in event m...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
versioned_docs/version-2.9.0/07-deployments/04-deploying-to-aws.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: .... Terraform will set up and manage your infrastructure while you use Github actions to manage ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: Possible missing comma found.
Context: ...ccess keys as you used to configure AWS CLI or generate a new pair. Sign in to Git...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~74-~74: Possible missing comma found.
Context: ...tings. Navigate to Secrets > Actions. Here you need to add three secrets for deplo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: “to” seems less likely than “the”.
Context: ...DK version. It is sufficient to specify to minor version. For example, if you are ...
(AI_HYDRA_LEO_CP_TO_THE)
[typographical] ~95-~95: After the expression ‘for example’ a comma is usually used.
Context: ...ou are using after DART_VERSION=. For example if you are using Dart 3.5.1, you can sp...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~105-~105: Possible missing preposition found.
Context: ... can upgrade dart by adding a few lines the code under `mypod_server/deploy/aws/scr...
(AI_HYDRA_LEO_MISSING_OF)
[grammar] ~155-~155: Possible subject-verb agreement error detected.
Context: ...arget EOF systemctl daemon-reload ``` This install the Dart SDK on the machine and change ...
(THIS_THAT_AGR)
[uncategorized] ~156-~156: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...install the Dart SDK on the machine and change the default Dart SDK version on the mac...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[style] ~162-~162: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...gure your Serverpod deployment scripts. You find the Terraform scripts in your serv...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~166-~166: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration file. In addition, you will also need to update the region in your Github deploy...
(REP_NEED_TO_VB)
[uncategorized] ~170-~170: Possible missing comma found.
Context: ...h as enabling Redis or adding a staging server by changing values in the script. You c...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~172-~172: It appears that a comma is missing.
Context: ...config/production.yamlfiles. In these files you should: 1. Replace theexamplepod...
(DURING_THAT_TIME_COMMA)
[style] ~176-~176: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ase with the database url from the RDS. Replace the url with the corresponding environm...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~184-~184: Possible missing comma found.
Context: ... have ssl enabled for the corresponding environment as RDS enable ssl by default. You can d...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~184-~184: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...or the corresponding environment as RDS enable ssl by default. You can do so by adding...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[style] ~215-~215: ‘make a plan’ might be wordy. Consider a shorter alternative.
Context: ... Terraform will now run some checks and make a plan for the deployment. If everything looks...
(EN_WORDINESS_PREMIUM_MAKE_A_PLAN)
[style] ~215-~215: To elevate your writing, consider using a more formal and concise alternative here.
Context: ...od, it will ask you if you are ready to go ahead with the changes. Type yes and hit th...
(GO_AHEAD_PROCEED)
[style] ~219-~219: Consider using a different adjective in this context to strengthen your wording.
Context: ...co](https://eggerapps.at/postico/) is a good option if you are on a Mac). Connect to...
(GOOD_ALTERNATIVE)
[style] ~229-~229: Consider using “outdated” to strengthen your wording.
Context: ... Deploy your code :::caution Using an old version of Serverpod cli will generate ...
(OLD_VERSION)
[uncategorized] ~229-~229: You might be missing the article “an” here.
Context: ...erate the Github action file containing old dart version that might not be the one ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[formatting] ~266-~266: Insert a comma after ‘OK’.
Context: ...ou will get a message similar to this: OK 2022-05-19 14:29:16.974160Z ## Trouble...
(SENT_START_THANKS_COMMA)
[style] ~271-~271: Consider replacing ‘often’ with a more meaningful word.
Context: ...yment that you won't have to touch very often. However, this section gives you some p...
(VERY_RB_STYLE)
[grammar] ~275-~275: With the double genitive (double possessive), use the possessive pronoun “yours”.
Context: ... your instances You can find a list of your currently running EC2 instances by navi...
(DOUBLE_GENITIVE_WRONG_PRONOUN)
[style] ~281-~281: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the service can be reached from local. If we get the expected response, we know t...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
versioned_docs/version-2.9.0/06-concepts/11-authentication/02-basics.md
[uncategorized] ~5-~5: “you” seems less likely than “you’re” (you are).
Context: ...a user. You should use this id whenever you a referring to a user. Access the id of...
(AI_HYDRA_LEO_CP_YOU_YOUARE)
[uncategorized] ~43-~43: The preposition ‘to’ seems more likely in this position.
Context: ... to a specific user. To restrict access for an endpoint, override the `requiredScop...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[uncategorized] ~132-~132: Possible missing article found.
Context: ...tus endpoint retrieves the user ID from session's authentication information, then revo...
(AI_HYDRA_LEO_MISSING_THE)
versioned_docs/version-2.9.0/06-concepts/06-database/08-transactions.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...a value. return true; }); ``` In the example we insert a company and an employee in ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...tionLevel.serializable), ); ``` In the example the isolation level is set to `Isolatio...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~54-~54: A comma might be missing here.
Context: ... first statement in the transaction was executed giving a consistent view of the databas...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~117-~117: A comma might be missing here.
Context: ...oints are created. After the company is inserted the first savepoint is released, which ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/06-custom-providers.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ... the existing providers supplied by the module along with the specific providers your ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~42-~42: A comma might be missing here.
Context: ...ds If other identification methods are required you can easily implement them by access...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~42-~42: Did you mean the adverb/preposition “within”?
Context: ... The UserInfo model can be interacted with in the same way as any other model with a ...
(WITH_IN)
[uncategorized] ~199-~199: Possible missing comma found.
Context: ...ssociated with the user. ##### Signing out a specific user In this example, a spe...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~211-~211: Possible missing comma found.
Context: ...n, userId: 123, ); ``` ##### Signing out the currently authenticated user If no...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/19-testing/02-the-basics.md
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...alse| The copyWith` method creates a new unique session builder with the provide...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~81-~81: Possible missing comma found.
Context: ...a session and pass it to the database call just as in production code. :::info B...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~84-~84: Did you mean: “By default,”?
Context: ...l just as in production code. :::info By default withServerpod does all database opera...
(BY_DEFAULT_COMMA)
[uncategorized] ~109-~109: Did you mean: “By default,”?
Context: ...ana'])); }); }); ``` ## Environment By default withServerpod uses the `test` run mod...
(BY_DEFAULT_COMMA)
[grammar] ~132-~132: The word “rollback” is a noun. The verb is spelled with a white space.
Context: ...|rollbackDatabase|Options for when to rollback the database during the test lifecycle ...
(NOUN_VERB_CONFUSION)
[uncategorized] ~136-~136: Possible missing comma found.
Context: ...onds: 30)| |testGroupTagsOverride|By default Serverpod test tools tags the withServ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~139-~139: Did you mean: “By default,”?
Context: ...se{#rollback-database-configuration} By defaultwithServerpod` does all database opera...
(BY_DEFAULT_COMMA)
[misspelling] ~158-~158: This word is normally spelled as one.
Context: ...ch other. While generally considered an anti-pattern, it can be useful when the set up for t...
(EN_COMPOUNDS_ANTI_PATTERN)
[uncategorized] ~158-~158: When ‘set-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...anti-pattern, it can be useful when the set up for the test group is very expensive. I...
(VERB_NOUN_CONFUSION)
[style] ~158-~158: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...l when the set up for the test group is very expensive. In this case rollbackDatabase can be...
(EN_WEAK_ADJECTIVE)
[formatting] ~158-~158: Consider inserting a comma after an introductory phrase for better readability.
Context: ...p for the test group is very expensive. In this case rollbackDatabase can be set to `Rollb...
(IN_THAT_CASE_COMMA)
[uncategorized] ~160-~160: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ols to do these operations as part of a top level transaction. In this case this feature ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[formatting] ~160-~160: Consider inserting a comma after an introductory phrase for better readability.
Context: ...ons as part of a top level transaction. In this case this feature should be disabled by pass...
(IN_THAT_CASE_COMMA)
[uncategorized] ~201-~201: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...rrency=1` flag to the dart test runner. Otherwise multiple tests might pollute each other...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~201-~201: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...rwise multiple tests might pollute each others database state: ```bash dart test -t i...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~207-~207: A comma might be missing here.
Context: ...tion --concurrency=1 ``` For the other cases this is not an issue, as each `withServ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~210-~210: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... is a specific edge case where the test tools behavior deviates from production behav...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~228-~228: A comma might be missing here.
Context: ...actise, but if the code under test does this setting rollbackDatabase to `Rollback...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/12-runtime-parameters.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...parameters cannot be set at the session level as this would create inconsistencies be...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~76-~76: Consider replacing this phrase with the adverb “consistently” to avoid wordiness.
Context: ...ps, that will always set all parameters in a consistent way. Existing parameter groups include: -...
(IN_A_X_MANNER)
[uncategorized] ~312-~312: Loose punctuation mark.
Context: ...dle scanning: - IterativeScan.off: Disables iterative scanning, using the ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ... behavior. - **IterativeScan.strict`**: Ensures results are in exact order by d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Loose punctuation mark.
Context: ...recision). - IterativeScan.relaxed: Allows slightly out-of-order results bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Possible missing comma found.
Context: ...**: Allows slightly out-of-order results but provides better recall. ## Testing wit...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/17-backward-compatibility.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...ers may still use older versions of the app as not everyone will update to the late...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~3-~3: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...dates through the app stores take time. Therefore it may be essential to make updates to ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...with endpoint inheritance An endpoint sub-class can ...
(EN_COMPOUNDS_SUB_CLASS)
[uncategorized] ~42-~42: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...dded parameter and the new return type. Additionally all the other inherited (and untouched)...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~48-~48: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nto that from the endpoint. In case you want to create a V2 version later, you might be...
(REP_WANT_TO_VB)
[uncategorized] ~50-~50: Possible missing comma found.
Context: ...ools you need to extend and update your API while gracefully moving clients along a...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/01-get-started/04-deployment.md
[uncategorized] ~16-~16: Did you mean: “By default,”?
Context: ...ssues/55195). ## Server configuration By default Serverpod is active on three ports: - ...
(BY_DEFAULT_COMMA)
[grammar] ~21-~21: A hyphen is missing in the adjective “built-in”.
Context: ...n connect to this port. - 8082: The built in webserver is running on this port. You...
(BUILT_IN_HYPHEN)
versioned_docs/version-2.9.0/06-concepts/12-file-uploads.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...oring files. This works well for testing but may not be performant in larger-scale a...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Consider removing “of” to be more concise
Context: ... using a Stream is better because not all of the data must be held in RAM memory. Finall...
(ALL_OF_THE)
[style] ~35-~35: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...use not all of the data must be held in RAM memory. Finally, you should verify the upload ...
(ACRONYM_TAUTOLOGY)
[misspelling] ~58-~58: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...is also accessible to the world through an URL. If it is private, it can only be a...
(EN_A_VS_AN)
versioned_docs/version-2.9.0/07-deployments/01-deployment-strategy.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... All features are supported. Great for real time communication. Cost efficient at scale...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[misspelling] ~11-~11: This word is normally spelled with a hyphen.
Context: ...ed. Great for real time communication. Cost efficient at scale. | Minimal starting cost. Eas...
(EN_COMPOUNDS_COST_EFFICIENT)
[uncategorized] ~29-~29: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...rm. The minimal setup can handle a fair amount of users at no additional cost. With mo...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...n cache data and state directly on your servers which can cut down costs as you scale. ...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/07-relation-queries.md
[typographical] ~3-~3: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...ncluding relational data structures. In SQL this is often achieved using a join ope...
(IN_NNP_COMMA)
[uncategorized] ~19-~19: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...clude(), ), ); ``` The example above return a employee including the related addres...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[misspelling] ~19-~19: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..., ), ); ``` The example above return a employee including the related address ...
(EN_A_VS_AN)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...n be included or not when making a query but only the includes that are explicitly d...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~74-~74: Consider inserting a comma for improved readability.
Context: ...used. When including something on a list it means that every entry in the list will...
(INITIAL_ADVP_COMMA)
[uncategorized] ~171-~171: Possible missing comma found.
Context: ...The example above retrieves the next 10 employees starting from the 11th record: Using t...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~190-~190: There seems to be a noun/verb agreement error. Did you mean “attaches” or “attached”?
Context: ...on, company!, employee!); ``` ### Bulk attach rows For scenarios where you need to a...
(SINGULAR_NOUN_VERB_AGREEMENT)
[grammar] ~211-~211: There seems to be a noun/verb agreement error. Did you mean “detaches” or “detached”?
Context: ...yees(session, employee!); ``` ### Bulk detach rows In cases where you need to remove...
(SINGULAR_NOUN_VERB_AGREEMENT)
[grammar] ~222-~222: Did you mean “attachment”?
Context: ...mployee!]); ``` :::note When using the attach and detach methods the objects passed t...
(A_ATTACH)
[uncategorized] ~222-~222: A comma might be missing here.
Context: ...::note When using the attach and detach methods the objects passed to them have to have...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/11-authentication/01-setup.md
[style] ~11-~11: It’s more common nowadays to write this noun as one word.
Context: ...handles basic user information, such as user names and profile pictures. Make sure to use ...
(RECOMMENDED_COMPOUNDS)
[uncategorized] ~54-~54: Possible missing comma found.
Context: ...t, you need to initialize the database. First you have to create a new migration that...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~106-~106: It’s more common nowadays to write this noun as one word.
Context: ... has been updated. This can be when the user name is changed or if the user uploads a new...
(RECOMMENDED_COMPOUNDS)
[style] ~113-~113: It’s more common nowadays to write this noun as one word.
Context: ... | True if users can edit their user names. ...
(RECOMMENDED_COMPOUNDS)
[style] ~115-~115: It’s more common nowadays to write this noun as one word.
Context: ... | True if users can view their user name. ...
(RECOMMENDED_COMPOUNDS)
[grammar] ~210-~210: When ‘signed-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... Register authentication To register a signed in user in the session manager: ```dart a...
(LOGGED_IN_HYPHEN)
versioned_docs/version-2.9.0/06-concepts/06-database/05-crud.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...ur generated models. For the following examples we will use this model: ```yaml class:...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~43-~43: Possible missing comma found.
Context: ...); ``` :::info In previous versions of Serverpod the insert method mutated the input o...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~43-~43: A comma might be missing here.
Context: ... setting the id field. In the example above the input variable remains unmodified a...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~107-~107: Possible missing comma found.
Context: ... must have its id set to a non-null value and the id needs to exist on a row in t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~111-~111: Possible missing comma found.
Context: ...e several rows To batch update several rows use the update method. ```dart var c...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~124-~124: Possible missing preposition found.
Context: ...e dart object has introduced a change. Update a single row, the following code will u...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~144-~144: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...Deleting rows from the database is done in a similar way to updating rows. However, there are th...
(IN_A_X_MANNER)
[grammar] ~182-~182: The verb ‘helps’ is used with an infinitive.
Context: ...t is a special type of query that helps counting the number of rows in the database that...
(ADVISE_VBG)
versioned_docs/version-2.9.0/06-concepts/06-database/01-connection.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: # Connection In Serverpod the connection details and password for...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~10-~10: A comma might be missing here.
Context: ...onnection details. For your development build you can find the connection details in ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~90-~90: The phrase “take into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...nce. There are a few things you need to take into consideration: - Make sure that your Postgres instan...
(TAKE_INTO_CONSIDERATION)
[uncategorized] ~112-~112: Possible missing comma found.
Context: ...hosting your Serverpod server on Google Cloud Run and changing the database host stri...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/07-deployments/02-deploying-to-gce-terraform.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: .... Terraform will set up and manage your infrastructure while you use Github to build your Dock...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~68-~68: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ervice account with Terraform, you will need to create a set of keys. Click on your new...
(REP_NEED_TO_VB)
[style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...__If you already have a domain that you want to use, you should skip this step and cont...
(REP_WANT_TO_VB)
[style] ~152-~152: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ..., then click Add Standard to create a new record set. Set the Resource record type to ...
(EN_WORDINESS_PREMIUM_NEW_RECORD)
[typographical] ~268-~268: It seems that a comma is missing.
Context: ...e your code is uploaded to the Artifact Registry you can restart the servers in your aut...
(IF_COMMA)
[misspelling] ~268-~268: This expression is normally spelled as one or with a hyphen.
Context: ...try you can restart the servers in your auto scaling group by opening the Google Cloud conso...
(EN_COMPOUNDS_AUTO_SCALING)
[style] ~272-~272: Consider a more expressive alternative.
Context: ...e servers when new code is deployed. To do this, uncomment the last section of the...
(DO_ACHIEVE)
versioned_docs/version-2.9.0/06-concepts/15-streams.md
[style] ~131-~131: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n the Endpoint. - handleStreamMessage is called when a serialized message is rec...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
versioned_docs/version-2.9.0/02-overview.md
[style] ~25-~25: Try using a synonym here to strengthen your writing.
Context: ...on` provides context about the call and gives access to server resources like the dat...
(GIVE_PROVIDE)
[style] ~51-~51: The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition.
Context: ...our server will use in its API and when talking with the database. You define serializable d...
(TALK_WITH)
[style] ~82-~82: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ...s (CRUD). For example, you can insert a new record and then query it as follows: ```dart ...
(EN_WORDINESS_PREMIUM_NEW_RECORD)
versioned_docs/version-2.9.0/06-concepts/19-testing/01-get-started.md
[uncategorized] ~22-~22: A comma might be missing here.
Context: ...s file is not generated. With the above config the location of the test tools file is ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~22-~22: This phrase is redundant. Consider using “outside”.
Context: ... be set to any folder (though should be outside of lib as per Dart's test conventions). ...
(OUTSIDE_OF)
[uncategorized] ~213-~213: Possible missing comma found.
Context: ...generated. ::: Before the test can be run the Postgres and Redis also have to be ...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/04-indexing.md
[uncategorized] ~34-~34: A comma might be missing here.
Context: ...s are unique for the table. This can be useful for example if you want to make sure th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~34-~34: A comma might be missing here.
Context: ...e for the table. This can be useful for example if you want to make sure that no two co...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~64-~64: Possible missing comma found.
Context: ... name type: brin ``` If no type is specified the default is btree. All [PostgreSQL...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...4 ``` Available HNSW parameters: - m: Maximum number of bidirectional links f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Available IVFFLAT parameters: - lists: Number of inverted lists (default: 100)...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~158-~158: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...:tip If more than one distance function is going to be frequently used on the same vector f...
(GOING_TO_WILL)
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/01-email.md
[uncategorized] ~91-~91: Possible missing comma found.
Context: ...lient.modules.auth); ``` To let a user signup first call the createAccountRequest m...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~91-~91: Consider using “email”.
Context: ...ethod which will trigger the backend to send an email to the user with the validation code. ```...
(SEND_AN_EMAIL)
[uncategorized] ~103-~103: A comma might be missing here.
Context: ...et users log in if they already have an account you can use the signIn method. ```da...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~108-~108: A comma may be missing after the conjunctive/linking adverb ‘Finally’.
Context: ...ontroller.signIn(email, password); ``` Finally to let a user reset their password you ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~121-~121: A comma might be missing here.
Context: ...word); ``` After the password has been reset you have to call the signIn method to...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...er letting the user type in the details again or simply chaining the resetPassword ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~187-~187: To make your writing flow more naturally, try moving the adverb ‘already’ closer to the verb ‘stored’.
Context: ... }, ) ``` It could be useful if you already have stored passwords that should be preserved or m...
(PERF_TENS_ADV_PLACEMENT)
versioned_docs/version-2.9.0/06-concepts/02-models.md
[grammar] ~3-~3: In the grammatical structure ‘pronoun + be/get + used + to + verb’, the verb ‘used’ is used with the gerund.
Context: ...alizable classes in Serverpod. They are used to generate Dart code for the server and client, an...
(ADMIT_ENJOY_VB)
[uncategorized] ~36-~36: Did you mean: “By default,”?
Context: ... to set a scope on a per-field basis. By default all fields are visible to both the serv...
(BY_DEFAULT_COMMA)
[uncategorized] ~55-~55: Possible missing comma found.
Context: ...n-depth description on how to work with exceptions see [Error handling and exceptions](exc...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~75-~75: Did you mean: “By default,”?
Context: ...imal values: - dog - cat - bird ``` By default the serialization will convert the enum...
(BY_DEFAULT_COMMA)
[uncategorized] ~87-~87: Possible missing comma found.
Context: ... - bird ``` serialized has two valid values `byName` and `byIndex`. When using `byN...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~87-~87: In American English, abbreviations like “etc.” require a period.
Context: ...ing byIndex the index value (0, 1, 2, etc) is used. :::info It's recommended to...
(ETC_PERIOD)
[uncategorized] ~97-~97: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... server, or if an enum option is removed but the database still contains the old val...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~120-~120: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...umentation to your serializable objects in a similar way that you would add documentation to you...
(IN_A_X_MANNER)
[uncategorized] ~213-~213: The preposition “for” seems more likely in this position.
Context: ...rpod generates some convenience methods on the Dart classes. ### copyWith The `c...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~228-~228: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...all serialization for you out of the box and you will rarely have to use these metho...
(COMMA_COMPOUND_SENTENCE)
[misspelling] ~228-~228: Did you mean “yourself”? Remove the space in between.
Context: ...ill rarely have to use these methods by your self. See the Serialization...
(YOUR_SELF_TO_YOURSELF)
[uncategorized] ~257-~257: You might be missing the article “the” here.
Context: ...s needed. It is not required to use all default types for a field. :::info When using...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~263-~263: Possible missing comma found.
Context: ...query will not use the defaultPersist value since the field already has a value ass...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/07-deployments/03-deploying-to-gcr-console.md
[uncategorized] ~3-~3: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...If your server does not maintain a state and you aren't using future calls, running ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...is the easiest way to deploy your server but may be less flexible as your applicatio...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~36-~36: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...uick coffee break. ### Create database user and database tables When the Postgres ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[style] ~43-~43: Consider using a different adjective in this context to strengthen your wording.
Context: ...ur favorite Postgres tool. Postico is a good option if you are on a Mac. Click on th...
(GOOD_ALTERNATIVE)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...rpod You will connect to Postgres from Cloud Run with the Cloud SQL Proxy. In your P...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/06-database/11-migrations.md
[uncategorized] ~11-~11: A comma might be missing here.
Context: ...in your model. When this flag is set to false the generated migrations will not defin...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~21-~21: Consider adding a comma.
Context: ...o transition a manually managed table to then be managed by Serverpod you first need ...
(IF_THEN_COMMA)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...lly managed table to then be managed by Serverpod you first need to set this flag to `tru...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: A comma might be missing here.
Context: .... ## Creating a migration To create a migration navigate to your project's server pac...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...base forward. If no previous migration exists it will create a migration assuming the...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~40-~40: There seems to be a noun/verb agreement error. Did you mean “creates” or “created”?
Context: ...ere introduced in Serverpod. ### Force create migration The migration command aborts...
(SINGULAR_NOUN_VERB_AGREEMENT)
[uncategorized] ~97-~97: Possible missing comma found.
Context: ...ions are applied as part of the startup sequence and the framework asserts that each mig...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~115-~115: A comma might be missing here.
Context: ...tion If the database has been manually modified the database schema may be out of sync ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...To preserve manually created or managed tables the [repair migration](#repair-migratio...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~194-~194: Possible missing comma found.
Context: ...ation is applied as part of the startup sequence and the framework asserts that each rep...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~210-~210: Possible missing comma found.
Context: ...lling back migrations Utilizing repair migrations it is easy to roll back the project to ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~210-~210: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...r migration targeting the migration you want to roll back to, then apply the repair mig...
(REP_WANT_TO_VB)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/01-one-to-one.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...key in the database. Without the unique index the relation would be considered a one-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...ning the Relationship In the following examples we show how to configure a 1:1 relation...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~35-~35: A comma might be missing here.
Context: ...int?. When fetching a Userfrom the database theaddressId` field will automaticall...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~67-~67: The preposition ‘of’ seems more likely in this position.
Context: ...ational table is inferred from the type on the field. ### Optional relation ```y...
(AI_HYDRA_LEO_REPLACE_ON_OF)
[style] ~104-~104: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...that the field keyword cannot be used in conjunction with the optional keyword. Instead, direct...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~134-~134: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...nt relations defined on both sides You are able to define as many independent relations as...
(BE_ABLE_TO)
[uncategorized] ~193-~193: A comma might be missing here.
Context: ...onship where there is an object on both sides a unique index is always required o...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/05-tutorials/02-tutorials/02-real-time-communication.md
[style] ~103-~103: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...hat define the dimensions of our image. We represent the image itself with a `Uint...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~164-~164: Consider placing the discourse marker ‘first’ at the beginning of the sentence for more clarity.
Context: ...returns a stream of updates to clients. This method first sends the full image data to the client...
(SENT_START_FIRST_PREMIUM)
[uncategorized] ~164-~164: The preposition ‘for’ seems more likely in this position.
Context: ... pixel updates. This method will listen to updates from our pixel-added channel ...
(AI_HYDRA_LEO_REPLACE_TO_FOR)
[uncategorized] ~214-~214: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...mePageclass toPixoramaApp. We also remove the demo code and replace it with a Sc...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~214-~214: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...aApp. We also remove the demo code and replace it with a Scaffoldcontaining aPixo...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/02-google.md
[style] ~12-~12: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...for Google Sign In. ::: :::caution You need to install the auth module before you cont...
(REP_NEED_TO_VB)
[grammar] ~17-~17: “Google” is a proper noun and needs to be capitalized.
Context: ...To implement Google Sign In, you need a google cloud project. You can create one in th...
(A_GOOGLE)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...ta and use the authentication method in Serverpod we have to enable the Peoples API in ou...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~39-~39: “Google” is a proper noun and needs to be capitalized.
Context: ...n Create the server credentials in the google cloud console. Navigate to _Credentials...
(A_GOOGLE)
[uncategorized] ~39-~39: A comma might be missing here.
Context: ... a Web application. If you have a domain add it to the `Authorized JavaScript or...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~65-~65: A comma might be missing here.
Context: ... credentials. Then download the plist file rename it to GoogleService-Info.plist...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...ck to the app after the user has signed in we have to add the URL Scheme, the sche...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~106-~106: A comma might be missing here.
Context: ... If you have any social logins in your app you also need to integrate "Sign in wit...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~114-~114: You might be missing the article “the” here.
Context: ...cation type Android. Fill in all required information, you can get the debug SHA-...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~119-~119: Possible missing comma found.
Context: ...rvices.json`. :::info For a production app you need to get the SHA-1 key from your...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ...o create any client credentials for the web we will simply pass the `serverClientId...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~130-~130: “Google” is a proper noun and needs to be capitalized.
Context: ...odify the server credentials inside the google cloud console. Navigate to _Credential...
(A_GOOGLE)
[uncategorized] ~144-~144: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ign-in. You can choose any path you want but it has to be the same in the credential...
(COMMA_COMPOUND_SENTENCE)
[style] ~202-~202: Consider a more expressive alternative.
Context: ...user's calendar, contacts, or files. To do this, you will need to: - Add the requ...
(DO_ACHIEVE)
versioned_docs/version-2.9.0/06-concepts/01-working-with-endpoints.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...lomethod. To generate the client-side code runserverpod generate` in the home di...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~35-~35: The operating system from Apple is written “macOS”.
Context: ...e local ip by running ifconfig (Linux/MacOS) or ipconfig (Windows). Make sure to...
(MAC_OS)
[formatting] ~113-~113: Consider inserting a comma after an introductory phrase for better readability.
Context: ...nc { return 'Bye $name'; } } ``` In this case the ExampleEndpoint will only expose ...
(IN_THAT_CASE_COMMA)
[style] ~223-~223: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ng you can add optional parameters, but can not add required parameters or change the r...
(CAN_NOT_PREMIUM)
[uncategorized] ~227-~227: Possible missing comma found.
Context: ...n case you want to hide methods from an endpoint use @doNotGenerate in the child class...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/08-upgrading/03-upgrade-to-two.md
[uncategorized] ~5-~5: A comma might be missing here.
Context: ... If you are not using authentication at all this change does not impact you. If you...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~5-~5: A comma might be missing here.
Context: ...t you. If you are using the auth module already the transition is simple. The default ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~7-~7: Possible missing preposition found.
Context: ...verpod object, in your server.dart file make the following change: ```dart import '...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~26-~26: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...hods signInUser and signOutUser now takes the session object as a param and is no...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~26-~26: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...takes the session object as a param and is no longer available on the session obje...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~26-~26: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...longer available on the session object. Instead import the class UserAuthentication f...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ey` has been removed from Serverpod core but is available in the serverpod_auth modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~34-~34: A comma might be missing here.
Context: ...before without using the serverpod_auth module you have to take care of managing your ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~64-~64: Did you mean “you are”, “yours are” or “your”?
Context: ...key_userId_idx: fields: userId ``` Your are then responsible for creating/removing ...
(YOUR_RE)
[uncategorized] ~107-~107: Possible missing comma found.
Context: ... authenticated property is set on the session it effectively means there is an authen...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~111-~111: Possible missing comma found.
Context: ...tion helpers The field auth has been removed and the methods signInUser and `signO...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~268-~268: Possible missing comma found.
Context: ...hange also applies to the id field of models where bigserial is now used to genera...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~270-~270: A comma might be missing here.
Context: ...tible with existing databases. Existing migrations therefore, won't be changed by the Serv...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~272-~272: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ... with the new representation. #### Why is this change made? The change was made ...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~276-~276: The preposition “to” seems more likely in this position.
Context: ...re are usually no significant drawbacks with using bigint instead of int. In mos...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[formatting] ~276-~276: Insert a comma after ‘cases’: “In most cases,”?
Context: ...s with using bigint instead of int. In most cases a good index strategy will be more impo...
(IN_MOST_CASES_COMMA)
[uncategorized] ~349-~349: Possible missing comma found.
Context: ...tion process not only for general models but also significantly enhances custom seri...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/08-upgrading/05-upgrade-to-pgvector.md
[grammar] ~80-~80: The verb form ‘is’ does not seem to match the subject ‘instructions’.
Context: ...:tip If the cloud provider instructions is to run a CREATE EXTENSION vector; com...
(SUBJECT_VERB_AGREEMENT_PLURAL)
versioned_docs/version-2.9.0/06-concepts/19-testing/04-best-practises.md
[style] ~10-~10: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...file exports everything that is needed. Adding an additional import is just unnecessary noise and will like...
(ADD_AN_ADDITIONAL)
[uncategorized] ~71-~71: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t methods directly would circumvent that and the code would not behave like producti...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~124-~124: Loose punctuation mark.
Context: ... folders in the server: - test/unit: Unit tests. - test/integration: Tests...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: .../unit: Unit tests. - test/integration`: Tests for endpoints or business logic m...
(UNLIKELY_OPENING_PUNCTUATION)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/05-referential-actions.md
[uncategorized] ~12-~12: The preposition “by” seems more likely in this position.
Context: ...eld. | | Cascade | Any action taken on the parent (update/delete) will be mirr...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[style] ~32-~32: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pdate=NoAction, onDelete=NoAction) ``` If the relation is defined as an [id relat...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/02-one-to-many.md
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...ning the relationship In the following examples we show how to configure a 1:n relation...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~34-~34: A comma might be missing here.
Context: ...) as a concealed column. When fetching companies it now becomes possible to include any ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~80-~80: Possible agreement error. The noun ‘side’ seems to be countable; consider using: “many sides”.
Context: ...tion](one-to-one#with-an-object) on the many side: ```yaml # company.yaml class: Company...
(MANY_NN)
[grammar] ~98-~98: Possible agreement error. The noun ‘side’ seems to be countable; consider using: “many sides”.
Context: ...ld](one-to-one#with-an-id-field) on the many side: ```yaml # company.yaml class: Company...
(MANY_NN)
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/03-apple.md
[grammar] ~8-~8: The operating system from Apple is written “macOS”.
Context: ...w, we have official support for iOS and MacOS for Sign in with Apple. ::: :::caution...
(MAC_OS)
[grammar] ~31-~31: The operating system from Apple is written “macOS”.
Context: ... type of configuration for your iOS and MacOS projects respectively. ![Add capabilit...
(MAC_OS)
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ... button serverpod_auth_apple_flutter package comes with the widget `SignInWithAppleB...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
versioned_docs/version-2.9.0/08-upgrading/04-upgrade-to-two-point-two.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...s file is not generated. With the above config the location of the test tools file is ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~15-~15: This phrase is redundant. Consider using “outside”.
Context: ... be set to any folder (though should be outside of lib as per Dart's test conventions). ...
(OUTSIDE_OF)
versioned_docs/version-2.9.0/01-get-started/01-creating-endpoints.md
[style] ~7-~7: The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition.
Context: ...y have in your fridge. Your server will talk with Google's Gemini API to make this magic ...
(TALK_WITH)
[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... could also use src/endpoints/ if you want to go layer first or `src/features/recipes...
(REP_WANT_TO_VB)
[style] ~107-~107: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...a status message to your client. If you want to run more complex computations, you can ...
(REP_WANT_TO_VB)
versioned_docs/version-2.9.0/01-get-started/03-working-with-the-database.md
[style] ~36-~36: Consider shortening or rephrasing this to strengthen your wording.
Context: ...our database schema over time. When you make changes to your models that affect the database st...
(MAKE_CHANGES)
[style] ~53-~53: Try using a synonym here to strengthen your writing.
Context: ...emodel, it becomes aTableRow` type, giving us access to database operations. Serverpo...
(GIVE_PROVIDE)
[style] ~179-~179: Try using a synonym here to strengthen your writing.
Context: ...el class definition, the model will now give you access to the database, specifically to...
(GIVE_PROVIDE)
[grammar] ~185-~185: Collocation: With the noun “changes”, you should use the verb “make”.
Context: ...ration in the previous step and haven't done any changes that affect the database. ...
(MAKE_A_CHANGE)
[style] ~194-~194: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e result in a list of Recipe objects. We will also update the UI to show the lis...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~198-~198: In this context, use the gerund without “to”.
Context: ...ou want to see what changed, we suggest to creating a git commit now and then replacing the...
(PRP_VB_TO_VBG)
versioned_docs/version-2.9.0/06-concepts/03-serialization.md
[style] ~96-~96: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ... you must run serverpod generate. You are now able to use this class in your endpoints and le...
(BE_ABLE_TO)
versioned_docs/version-2.9.0/06-concepts/06-database/06-filter.md
[uncategorized] ~3-~3: You might be missing the article “an” here.
Context: ...er function. A callback is then used as argument to the where parameter when fetching ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[uncategorized] ~10-~10: Possible missing comma found.
Context: ... practice to place them within a set of parentheses as the precedence rules are not always ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~23-~23: A comma might be missing here.
Context: ...> t.name.equals('Alice') ); ``` In the example we fetch all users with the name Alice....
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~34-~34: A comma might be missing here.
Context: ... t.name.notEquals('Bob') ); ``` In the example we fetch all users with a name that is ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~47-~47: A comma might be missing here.
Context: ...where: (t) => t.age > 25 ); ``` In the example we fetch all users that are older than ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~47-~47: Consider using “who” when you are referring to people instead of objects.
Context: ... In the example we fetch all users that are older than 25 years old. dart a...
(THAT_WHO)
[uncategorized] ~56-~56: A comma might be missing here.
Context: ...here: (t) => t.age >= 25 ); ``` In the example we fetch users that are 25 years old or...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~56-~56: Consider using “who” when you are referring to people instead of objects.
Context: ...5 ); In the example we fetch users that are 25 years old or older. dart awa...
(THAT_WHO)
[style] ~64-~64: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ion, where: (t) => t.age < 25 ); ``` In the example we fetch all users that are...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~65-~65: A comma might be missing here.
Context: ...where: (t) => t.age < 25 ); ``` In the example we fetch all users that are younger tha...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~65-~65: Consider using “who” when you are referring to people instead of objects.
Context: ... In the example we fetch all users that are younger than 25 years old. dart...
(THAT_WHO)
[style] ~73-~73: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...on, where: (t) => t.age <= 25 ); ``` In the example we fetch all users that are...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~74-~74: Possible missing comma found.
Context: ...here: (t) => t.age <= 25 ); ``` In the example we fetch all users that are 25 years ol...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~74-~74: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that are 25 years old or younger. ### Betwe...
(THAT_WHO)
[uncategorized] ~78-~78: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...thod takes two values and checks if the columns value is between the two input variable...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~87-~87: A comma might be missing here.
Context: ...=> t.age.between(18, 65) ); ``` In the example we fetch all users between 18 and 65 ye...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~98-~98: A comma might be missing here.
Context: ...t.age.notBetween(18, 65) ); ``` In the example we fetch all users that are not between...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~98-~98: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that are not between 18 and 65 years old. Th...
(THAT_WHO)
[uncategorized] ~111-~111: Possible missing comma found.
Context: ....inSet({'Alice', 'Bob'}) ); ``` In the example we fetch all users with a name matching...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~122-~122: A comma might be missing here.
Context: ...tInSet({'Alice', 'Bob'}) ); ``` In the example we fetch all users with a name not matc...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~128-~128: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...artial entries. Two special characters enables matching against partial entries. - **...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~149-~149: A comma might be missing here.
Context: ...(t) => t.name.like('A%') ); ``` In the example we fetch all users with a name that sta...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~160-~160: A comma might be missing here.
Context: ... => t.name.notLike('B%') ); ``` In the example we fetch all users with a name that doe...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~173-~173: A comma might be missing here.
Context: ...t) => t.name.ilike('a%') ); ``` In the example we fetch all users with a name that sta...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~184-~184: A comma might be missing here.
Context: ...=> t.name.notIlike('b%') ); ``` In the example we fetch all users with a name that doe...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~199-~199: Possible missing comma found.
Context: ...'Alice') & (t.age > 25)) ); ``` In the example we fetch all users with the name "Alice...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~210-~210: A comma might be missing here.
Context: ...%') | t.name.like('B%')) ); ``` In the example we fetch all users that has a name that...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~210-~210: Possible subject-verb agreement error detected.
Context: ... In the example we fetch all users that has a name that starts with A or B. ### ...
(PLURAL_THAT_AGREEMENT)
[uncategorized] ~284-~284: A comma might be missing here.
Context: ... in Serverpod. ### One-to-one For 1:1 relations the columns of the relation can be acce...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~293-~293: A comma might be missing here.
Context: ...ss.street.like('%road%') ); ``` In the example each user has a relation to an address ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~293-~293: Possible missing comma found.
Context: ...that has a street field. Using relation operations we then fetch all users where the relat...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~310-~310: A comma might be missing here.
Context: ... => t.orders.count() > 3 ); ``` In the example we fetch all users with more than three...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~312-~312: Possible missing comma found.
Context: ...e can apply a sub-filter to the count operator filter the related entries before they ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~312-~312: Possible missing preposition found.
Context: ...ly a sub-filter to the count operator filter the related entries before they are cou...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~321-~321: A comma might be missing here.
Context: ...Type.equals('book')) > 3 ); ``` In the example we fetch all users with more than three...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~325-~325: Possible missing comma found.
Context: ...e no related entries in a 1:n relation. Meaning if there exists a related entry then th...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~325-~325: Possible agreement error. The noun ‘relation’ seems to be countable; consider using: “many relations”.
Context: ... is useful if you want to ensure that a many relation does not contain any related rows. ```...
(MANY_NN)
[uncategorized] ~334-~334: A comma might be missing here.
Context: ...: (t) => t.orders.none() ); ``` In the example we fetch all users that have no orders....
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~334-~334: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that have no orders. We can apply a sub-fil...
(THAT_WHO)
[uncategorized] ~336-~336: Possible missing comma found.
Context: ...operator to filter the related entries. Meaning if there is a match in the sub-filter t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~345-~345: A comma might be missing here.
Context: ...temType.equals('book'))) ); ``` In the example we fetch all users that have no "book" ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~345-~345: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that have no "book" orders. #### Any Any w...
(THAT_WHO)
[typographical] ~349-~349: Consider adding a comma.
Context: ... Dart. If there exists any related entry then include the row in the result. ```dart...
(IF_THEN_COMMA)
[uncategorized] ~358-~358: Possible missing comma found.
Context: ...e: (t) => t.orders.any() ); ``` In the example we fetch all users that have any order....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~358-~358: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that have any order. We can apply a sub-fil...
(THAT_WHO)
[uncategorized] ~360-~360: Possible missing comma found.
Context: ...operator to filter the related entries. Meaning if there is a match in the sub-filter t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~369-~369: A comma might be missing here.
Context: ...temType.equals('book'))) ); ``` In the example we fetch all users that have any "book"...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~369-~369: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that have any "book" order. #### Every Eve...
(THAT_WHO)
[grammar] ~373-~373: The noun should probably be in the singular form.
Context: ...ve any "book" order. #### Every Every works similarly to the every method on list...
(EVERY_EACH_SINGULAR)
[typographical] ~373-~373: Consider adding a comma.
Context: ...ery related entry matches the sub-filter then include the row in the result. For the ...
(IF_THEN_COMMA)
[uncategorized] ~373-~373: Possible missing comma found.
Context: ... the row in the result. For the every operator the sub-filter is mandatory. ```dart a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~382-~382: A comma might be missing here.
Context: ...itemType.equals('book')) ); ``` In the example we fetch all users that have only "book...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~382-~382: Consider using “who” when you are referring to people instead of objects.
Context: ... ``` In the example we fetch all users that have only "book" orders.
(THAT_WHO)
versioned_docs/version-2.9.0/08-upgrading/02-upgrade-to-one-point-two.md
[grammar] ~3-~3: The verb form ‘works’ does not seem to match the subject ‘methods’.
Context: ... the new methods. The old methods still works, but have been deprecated and will be p...
(SUBJECT_VERB_AGREEMENT_PLURAL)
[uncategorized] ~9-~9: “you” seems less likely than “your” (belonging to you).
Context: ...asier. ## Updating your CLI To update you Serverpod command line interface to the...
(AI_HYDRA_LEO_CP_YOU_YOUR)
[uncategorized] ~103-~103: You might be missing the article “the” here.
Context: ...dditions and changes to the syntax. All old keywords still work, but `serverpod gen...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~177-~177: Possible missing comma found.
Context: ...rojects that don't need to preserve any data and another for those that do. The gui...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~183-~183: Consider an alternative for the often overused word ‘important’.
Context: ... ### No data to preserve If it is not important to preserve the data that is in your da...
(NOT_IMPORTANT)
[uncategorized] ~187-~187: It appears that hyphens are missing in the adjective “up-to-date”.
Context: .... This ensures that the project is up to date with the latest version of Serverpod. N...
(UP_TO_DATE_HYPHEN)
[uncategorized] ~203-~203: A comma might be missing here.
Context: ...e the existing database and start a new one run the following commands: ```bas...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~210-~210: Possible missing comma found.
Context: ...es the running container along with its volume and the second command starts a new dat...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~226-~226: It appears that hyphens are missing in the adjective “up-to-date”.
Context: .... This ensures that the project is up to date with the latest version of Serverpod. N...
(UP_TO_DATE_HYPHEN)
[uncategorized] ~242-~242: Possible missing comma found.
Context: ...the command to fetch your live database schema it requires a running server. Navigate ...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/18-webserver.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... method call from an app. This makes it very easy to share data for applications that nee...
(EN_WEAK_ADJECTIVE)
[style] ~74-~74: Try using a synonym here to strengthen your writing.
Context: ...idgetRouteclass'build` method. This gives you access to all the features you typicall...
(GIVE_PROVIDE)
[grammar] ~74-~74: It seems that a verb is missing.
Context: ...e, logging, or caching the same way you would in a method call.
(MD_DT_JJ)
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/04-self-relations.md
[uncategorized] ~23-~23: Possible missing comma found.
Context: ...xt post represents the object on "this" side while the previous post is the correspo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...-many In a one-to-many self-referenced relation there is one object field connected to ...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~27-~27: It appears that a comma is missing.
Context: ...ield connected to a list field. In this example we have modeled the relationship betwee...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...s by looking at the motherId of other cats which should match the id field of th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~38-~38: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...t cat and matching it against one other cat id field. ## Many-to-many Let's ima...
(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[grammar] ~42-~42: This noun is normally spelled as one.
Context: ... by modeling the data as a many-to-many relation ship. Each member has a list of all other m...
(SHIP_COMPOUNDS)
[style] ~44-~44: Consider using “who” when you are referring to people instead of objects.
Context: ...locking and another list of all members that are blocking them. But since the list s...
(THAT_WHO)
[uncategorized] ~69-~69: A comma might be missing here.
Context: ...ascade delete means that if a member is deleted all the blocking entries are also remov...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/05-firebase.md
[uncategorized] ~13-~13: Possible missing comma found.
Context: ... your Firebase project. To create a new key go to the [Firebase console](https://co...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~17-~17: A comma might be missing here.
Context: ...the name does not follow the convention here the authentication with firebase will f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~86-~86: The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition.
Context: ...leris the Serverpod client you use to talk with the server andauthProviders` a list w...
(TALK_WITH)
[uncategorized] ~86-~86: The preposition “of” seems more likely in this position.
Context: ...h the server and authProviders a list with the firebase auth providers you want to...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
versioned_docs/version-2.9.0/01-get-started/02-models-and-data.md
[uncategorized] ~138-~138: Possible missing comma found.
Context: ... Now that we have created the Recipe model we can use it in the client. We will do...
(AI_HYDRA_LEO_MISSING_COMMA)
versioned_docs/version-2.9.0/06-concepts/21-experimental.md
[grammar] ~3-~3: Did you mean “is” or “can be”?
Context: # Experimental features :::warning Be cautious when using experimental featur...
(BE_IS)
[uncategorized] ~4-~4: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...onments, as their stability is uncertain and they may receive breaking changes in up...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...that are currently under development or testing or whose API is not yet stable. These f...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~16-~16: Possible missing comma found.
Context: ...odclass. When an experimental feature matures it is moved fromexperimentaltoSer...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~59-~59: You might be missing the article “a” here.
Context: ... This will generate a class with bothnameandage` field. ```dart class Ch...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~59-~59: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...rate a class with both name and age field. ```dart class ChildClass extends Pare...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~170-~170: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...cEventrepresents an event that occurs in the server.DiagnosticEventHandler` im...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[style] ~171-~171: Consider a more concise word here.
Context: ...plementations can react to these events in order to gain insights into the behavior of the ...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~174-~174: A comma might be missing here.
Context: ...he behavior of the server. As the name suggests the handlers should perform diagnostics...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~178-~178: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...andlers are typically run concurrently, can not depend on each other, and asynchronousl...
(CAN_NOT_PREMIUM)
[uncategorized] ~182-~182: Possible missing comma found.
Context: ...triggered from. If a handler throws an exception it will be logged to stderr and otherwi...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
versioned_docs/version-2.9.0/04-support.md
28-28: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
🔇 Additional comments (39)
versioned_docs/version-2.9.0/08-upgrading/_category_.json (1)
1-3: Category JSON is valid and complete.The
labelfield is correctly specified and the JSON structure is syntactically correct, so the “🔄 Upgrading” category will render properly in the sidebar.versioned_docs/version-2.9.0/06-concepts/_category_.json (1)
1-4: Add category config for Concepts ReferenceThe JSON configuration correctly defines the "📚 Reference" category and sets it to collapsed by default, aligning with the rest of the docs structure.
versioned_docs/version-2.9.0/06-concepts/19-testing/_category_.json (1)
1-4: Add category config for TestingThe "Testing" category is properly configured and collapsed by default. Consider adding an emoji (e.g., 🧪) for consistency with other category labels, though this is optional.
versions.json (1)
1-5: Add new version entryThe new version
"2.9.0"is correctly inserted at the top of the list, maintaining descending order and valid JSON.versioned_docs/version-2.9.0/05-tutorials/_category_.json (1)
1-4: Category JSON is correctly configured.
The "🎓 Learn Serverpod" category is labeled and expanded (collapsed: false) as intended.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/_category_.json (1)
1-4: Category configuration looks good.
The "Relations" category is properly labeled and collapsed by default.versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/_category_.json (1)
1-4: Category configuration is correct.
The "Providers" category is labeled and collapsed as expected.versioned_docs/version-2.9.0/06-concepts/06-database/_category_.json (1)
1-4: Category configuration is correct.
The "Database" category is labeled and collapsed by default.versioned_docs/version-2.9.0/01-get-started/_category_.json (1)
1-4: JSON category is valid and well-formatted.
The label, collapsed state, and indentation are correct for the "🚀 Getting started" section.versioned_sidebars/version-2.9.0-sidebars.json (1)
1-6: Valid JSON and autogenerated sidebar configuration
Theautogenerateddirective correctly pulls in all versioned docs under this directory.versioned_docs/version-2.9.0/06-concepts/13-health-checks.md (1)
1-40: Documentation looks good
Clear overview of built-in and custom health checks, with working Dart examples.versioned_docs/version-2.9.0/06-concepts/11-authentication/03-working-with-users.md (1)
1-32: Documentation is clear and comprehensive
Great examples for fetching and displaying user info, including widget usage.versioned_docs/version-2.9.0/06-concepts/20-security-configuration.md (1)
1-55: Documentation is accurate and well-structured
Clear security guidance for both server and client TLS configuration.versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/05-referential-actions.md (1)
1-55: Docs are comprehensive and correct
Good coverage of referential-action options and examples.versioned_docs/version-2.9.0/08-upgrading/05-upgrade-to-pgvector.md (2)
3-42: The introduction, info/warning blocks, Docker instructions, vector field snippets, and troubleshooting steps are clear and comprehensive.Also applies to: 83-90
71-71: ```shell
#!/bin/bashSearch for any migrations markdown file across all versioned_docs
find versioned_docs -type f -iname "migrations.md"
</details> <details> <summary>versioned_docs/version-2.9.0/01-get-started/04-deployment.md (1)</summary> `1-16`: The deployment guide’s structure and content are clear and well organized. Also applies to: 22-38 </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/08-caching.md (1)</summary> `1-16`: The rest of the caching guide is accurate and well structured. Also applies to: 27-60 </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/19-testing/03-advanced-examples.md (1)</summary> `7-16`: Examples are clear and code snippets correctly illustrate the advanced testing workflows. Also applies to: 25-116 </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/19-testing/04-best-practises.md (1)</summary> `1-9`: The rest of the best practices guide is precise and well organized. Also applies to: 11-70, 72-126 </details> <details> <summary>versioned_docs/version-2.9.0/07-deployments/03-deploying-to-gcr-console.md (1)</summary> `1-103`: **Comprehensive and clear deployment guide** The instructions are detailed, well-structured, and cover prerequisites, setup, and next steps. No issues found. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/01-email.md (2)</summary> `7-9`: **Verify relative link to Setup documentation.** The link `[Setup](../setup)` may need to include the numeric prefix or `.md` extension depending on MkDocs configuration to correctly resolve to `01-setup.md`. Please confirm this resolves properly in the generated site. --- `1-194`: **New email provider guide is comprehensive and clear.** Content thoroughly covers server- and client-side setup with code examples and security considerations. No changes needed. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/06-database/06-filter.md (1)</summary> `1-277`: **Filter expressions guide looks comprehensive and well-structured.** Examples and description of operators and relations are clear. </details> <details> <summary>versioned_docs/version-2.9.0/07-deployments/04-deploying-to-aws.md (1)</summary> `1-290`: **AWS deployment guide is detailed and actionable.** Structure and examples are solid; no major issues found. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/06-database/05-crud.md (1)</summary> `1-192`: **CRUD documentation is thorough with clear examples.** Everything from create to count operations is well-explained. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/11-authentication/05-custom-overrides.md (1)</summary> `1-261`: **Custom authentication overrides guide is clear and comprehensive.** Examples cover server- and client-side handlers and revocation flows. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/19-testing/02-the-basics.md (1)</summary> `1-2`: **Approve documentation changes.** Clear, comprehensive testing guide covering `withServerpod` usage, seeding, configuration, and best practices. </details> <details> <summary>versioned_docs/version-2.9.0/07-deployments/02-deploying-to-gce-terraform.md (1)</summary> `1-4`: **Approve deployment guide.** Thorough, step-by-step Terraform + GitHub Actions instructions with clear prerequisites and diagrams. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/11-authentication/01-setup.md (1)</summary> `1-3`: **Approve authentication setup guide.** Clear intro to `serverpod_auth` module installation, configuration, and client setup. </details> <details> <summary>versioned_docs/version-2.9.0/08-upgrading/02-upgrade-to-one-point-two.md (1)</summary> `1-4`: **Approve upgrade instructions.** Comprehensive guide for migrating to Serverpod 1.2 with clear paths for data preservation. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/06-custom-providers.md (1)</summary> `1-4`: **Approve custom provider documentation.** Well-structured guide covering server/client setup, token management, and security warnings. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/04-self-relations.md (1)</summary> `1-4`: **Well-structured introduction and examples.** The explanations of self-relations and YAML snippets are clear and align with existing relation docs. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/15-streams.md (1)</summary> `1-178`: **Documentation is comprehensive and clear.** Covers both streaming methods and endpoints with examples, lifecycle, authentication, and error handling. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/18-webserver.md (1)</summary> `1-75`: **Web server documentation looks solid.** The guides on routes, widgets, and static file handling integrate well with other conceptual docs. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/06-database/12-runtime-parameters.md (1)</summary> `1-384`: **Documentation is thorough and accurate.** Provides clear instructions on scopes, builders, parameter groups, and testing patterns for runtime parameters. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/02-models.md (1)</summary> `1-449`: **Models documentation is comprehensive.** Covers YAML syntax, field types, defaults, visibility scopes, and generated code features cohesively. </details> <details> <summary>versioned_docs/version-2.9.0/06-concepts/06-database/11-migrations.md (1)</summary> `38-39`: **Verify upgrade path link correctness.** The link points to an older “upgrade-to-one-point-two” guide. Ensure this is intentional for version 2.9.0 or update to the current upgrade instructions. </details> <details> <summary>versioned_docs/version-2.9.0/05-tutorials/02-tutorials/02-real-time-communication.md (1)</summary> `1-404`: **Documentation is clear and comprehensive. No changes requested.** </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
versioned_docs/version-2.9.0/05-tutorials/02-tutorials/01-fundamentals.md
Show resolved
Hide resolved
versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/06-modules.md
Show resolved
Hide resolved
versioned_docs/version-2.9.0/01-get-started/03-working-with-the-database.md
Show resolved
Hide resolved
versioned_docs/version-2.9.0/08-upgrading/02-upgrade-to-one-point-two.md
Show resolved
Hide resolved
versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/06-custom-providers.md
Show resolved
Hide resolved
✅ Actions performedReviews paused. |
|
@coderabbitai resolve |
✅ Actions performedComments resolved. |
This PR should not be merged until we have released 2.9.0 from this tag: #307 chore: Create version 2.9.0
Summary by CodeRabbit