fix typos

[omahs]

fix typos

Summary by CodeRabbit

• Documentation
  • Improved readability and clarity in the ImpactQL documentation.
  • Corrected spelling errors and enhanced text understanding in campaign instructions.
  • Minor text adjustments in the power boosting documentation for accuracy and clarity.

[Meriem-BM]

Thanks @omahs

[coderabbitai]

Walkthrough

The changes primarily involve semantic enhancements to the documentation for ImpactQL, focusing on correcting spelling errors and improving clarity in instructions and descriptions provided to enhance readability and comprehension. There are no changes to the core functionality or the exported/public entities of the GraphQL server, ensuring that the operational aspects remain consistent.

Changes

Files	Change Summary
README.md	Corrected spelling errors and improved clarity in instructions and descriptions.
docs/campaignsInstruction.md	Corrected text clarity, consistent descriptions, and instructions related to campaign creation, sorting fields, and filter fields.
docs/powerBoosting.md	Minor text adjustments in cronjob expressions description and explanation of handling unverified projects.

Poem

The docs are clear, the text refined,
Each line a clearer path you'll find.
No typo sails, no unclear seas,
Just streamlined notes and calm decrees.
With ImpactQL, code shines bright,
Thanks to the rabbit's touch, it's right!
🌟🐇📘

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dc2009f and ff285de.

Files selected for processing (3)

• README.md (6 hunks)
• docs/campaignsInstruction.md (1 hunks)
• docs/powerBoosting.md (2 hunks)

Additional context used

LanguageTool

docs/campaignsInstruction.md

[grammar] ~7-~7: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...e of * ManuallySelected: In these type of projects we pick some projects to sh...

(TYPE_OF_PLURAL)

---

[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...-d2b13e0e2c26.png"> * SortField: Sometimes in a campaign we just want t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ... this campaign you set SortField as campaign type and then you can use one of below ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[uncategorized] ~10-~10: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n you set SortField as campaign type and then you can use one of below sorting f...

(COMMA_COMPOUND_SENTENCE)

---

[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...e61f7dfd78a8.png"> * FilterFields: Sometimes we need to filter some projec...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...3b1ede865.png"> * WithoutProjects: Some campaigns don't include any projec...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~14-~14: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...paigns don't include any project in them and they are just some banner like **Feelin...

(COMMA_COMPOUND_SENTENCE)

---

[uncategorized] ~14-~14: some implies number and usually requires a plural noun.
Context: ... project in them and they are just some banner like Feeling $nice? campaign in bel...

(PLURALITY_OF_SEVERAL_NN_LIKE)

---

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...a-849c-7c02c1909884.png"> * Is Active:Optional, if you check it, it will a...

(UNLIKELY_OPENING_PUNCTUATION)

---

[typographical] ~16-~16: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...l**, if you check it, it will appear in frontend otherwise it seems you deleted/archived this camp...

(THUS_SENTENCE)

---

[uncategorized] ~18-~18: Loose punctuation mark.
Context: ... this field in frontend? * Is Featured:Optional, @MohammadPCh Can you help...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~19-~19: Loose punctuation mark.
Context: ... this field in frontend? * Description:Required, Write down something about...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~19-~19: You might be missing the article “the” here.
Context: ...Required*, Write down something about campaign and we show it like **Donate eligible t...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[uncategorized] ~19-~19: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...d**, Write down something about campaign and we show it like **Donate eligible token...

(COMMA_COMPOUND_SENTENCE)

---

[grammar] ~20-~20: There is an agreement error between ‘guess’ and ‘frontend’. Insert ‘a(n)’ or change the noun to plural.
Context: ...Hashtags`:Optional, @MohammadPCh I guess frontend doesn't use it anymore, am I right? * ...

(PRP_VB_NN)

---

[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...am I right? * Related Projects Slugs : It's just Required for campaigns wi...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...ected, I already explained it above in **type** section * Photo`: Optional,...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ... This is the image link that we show in campaign banner, first you need to upload image ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[typographical] ~25-~25: It seems that a comma is missing.
Context: ...ou want to show a campaign before others please fill order for it ( we show 1 after tha...

(IF_PLEASE_COMMA)

---

[typographical] ~25-~25: Two consecutive dots
Context: ... order for it ( we show 1 after that 2, ..) and after those campaigns we show camp...

(DOUBLE_PUNCTUATION)

---

[style] ~26-~26: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nding Link`: Optional, Sometime we want to redirect user to an external link when ...

(REP_WANT_TO_VB)

---

[style] ~26-~26: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... to a project list page, in case of you want to redirect to an external link, please fi...

(REP_WANT_TO_VB)

---

[style] ~28-~28: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...type** section * Sorting Field: It's just Required for campaigns with type `S...

(REP_BE_JUST)

docs/powerBoosting.md

[grammar] ~124-~124: This question may be missing the auxiliary verb ‘do’.
Context: ...ime of the snapshot is not filled. How we fill the balance? We already have filled the...

(MISSING_AUX_QS)

---

[style] ~124-~124: To make your writing flow more naturally, try moving the adverb ‘already’ closer to the verb ‘filled’.
Context: ...ot filled. How we fill the balance? We already have filled the blockNumber in powerSnapshot so...

(PERF_TENS_ADV_PLACEMENT)

---

[uncategorized] ~124-~124: Possible missing comma found.
Context: ...eady have filled the blockNumber in powerSnapshot so we call the subgraph and ask user's ...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[grammar] ~267-~267: Please double-check that the subject and verb are in the correct order to formulate a question.
Context: ...-dapps-v2/issues/1839 ## FAQ ### What we do if a project that has some boosting got...

(HOW_YOU_ARE)

---

[typographical] ~270-~270: There might be a comma missing.
Context: ...t project but immediately after it gets verified we start to save power_boosting_snapsho...

(IF_PRP_PRP_COMMA)

README.md

[misspelling] ~130-~130: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...eof user toadminin db Now you can login in admin dashboard with your user'sem...

(LOG_IN)

Markdownlint

docs/campaignsInstruction.md

7-7: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

10-10: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

12-12: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

14-14: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

22-22: null
Bare URL used

(MD034, no-bare-urls)

---

10-10: null
Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

README.md

133-133: null
Bare URL used

(MD034, no-bare-urls)

---

139-139: null
Bare URL used

(MD034, no-bare-urls)

---

144-144: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

229-229: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (11)

docs/campaignsInstruction.md (6)

10-10: Typo Fix Approved: Corrected "an specified order" to "a specified order".

This change improves the readability of the documentation.

Tools

LanguageTool

[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...-d2b13e0e2c26.png"> * SortField: Sometimes in a campaign we just want t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ... this campaign you set SortField as campaign type and then you can use one of below ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[uncategorized] ~10-~10: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n you set SortField as campaign type and then you can use one of below sorting f...

(COMMA_COMPOUND_SENTENCE)

Markdownlint

10-10: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

10-10: null
Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

---

12-12: Typo Fix Approved: Corrected "Let's verified projects that accept funds on Gnosis chain" to "Let's choose verified projects that accept funds on Gnosis chain".

This change improves the clarity of the documentation.

Tools

LanguageTool

[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...e61f7dfd78a8.png"> * FilterFields: Sometimes we need to filter some projec...

(UNLIKELY_OPENING_PUNCTUATION)

Markdownlint

12-12: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

16-16: Grammar Fix Approved: Corrected "it would be appear in frontend" to "it will appear in frontend".

This change improves the grammar and readability of the documentation.

Tools

LanguageTool

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...a-849c-7c02c1909884.png"> * Is Active:Optional, if you check it, it will a...

(UNLIKELY_OPENING_PUNCTUATION)

---

[typographical] ~16-~16: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...l**, if you check it, it will appear in frontend otherwise it seems you deleted/archived this camp...

(THUS_SENTENCE)

---

24-24: Typo Fix Approved: Corrected "show that as vodeo's preview" to "show that as video's preview".

This change fixes a typo and improves the readability of the documentation.

---

25-25: Typo Fix Approved: Corrected "we show 1 after that 2, .." to "we show 1, then 2, and so on".

This change improves the clarity of the documentation.

Tools

LanguageTool

[typographical] ~25-~25: It seems that a comma is missing.
Context: ...ou want to show a campaign before others please fill order for it ( we show 1 after tha...

(IF_PLEASE_COMMA)

---

[typographical] ~25-~25: Two consecutive dots
Context: ... order for it ( we show 1 after that 2, ..) and after those campaigns we show camp...

(DOUBLE_PUNCTUATION)

---

26-26: Typo Fix Approved: Corrected "Exlore" to "Explore" and improved sentence structure.

This change fixes a typo and improves the clarity of the documentation.

Tools

LanguageTool

[style] ~26-~26: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nding Link`: Optional, Sometime we want to redirect user to an external link when ...

(REP_WANT_TO_VB)

---

[style] ~26-~26: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... to a project list page, in case of you want to redirect to an external link, please fi...

(REP_WANT_TO_VB)

docs/powerBoosting.md (2)

122-124: Text Clarity Improvement Approved: Enhanced the description of the cronjob expression for filling power balance.

This change improves the clarity and correctness of the documentation.

Tools

LanguageTool

[grammar] ~124-~124: This question may be missing the auxiliary verb ‘do’.
Context: ...ime of the snapshot is not filled. How we fill the balance? We already have filled the...

(MISSING_AUX_QS)

---

[style] ~124-~124: To make your writing flow more naturally, try moving the adverb ‘already’ closer to the verb ‘filled’.
Context: ...ot filled. How we fill the balance? We already have filled the blockNumber in powerSnapshot so...

(PERF_TENS_ADV_PLACEMENT)

---

[uncategorized] ~124-~124: Possible missing comma found.
Context: ...eady have filled the blockNumber in powerSnapshot so we call the subgraph and ask user's ...

(AI_HYDRA_LEO_MISSING_COMMA)

---

267-270: Text Clarity Improvement Approved: Enhanced the description of handling unverified projects in power boosting snapshots.

This change improves the clarity and correctness of the documentation.

Tools

LanguageTool

[grammar] ~267-~267: Please double-check that the subject and verb are in the correct order to formulate a question.
Context: ...-dapps-v2/issues/1839 ## FAQ ### What we do if a project that has some boosting got...

(HOW_YOU_ARE)

---

[typographical] ~270-~270: There might be a comma missing.
Context: ...t project but immediately after it gets verified we start to save power_boosting_snapsho...

(IF_PRP_PRP_COMMA)

README.md (3)

13-13: Text Clarity Improvement Approved: Enhanced the description of ImpactQL.

This change improves the clarity and correctness of the documentation.

---

34-34: Text Clarity Improvement Approved: Enhanced the installation instructions.

This change improves the clarity and correctness of the documentation.

---

132-132: Text Clarity Improvement Approved: Enhanced the description of the admin user creation script.

This change improves the clarity and correctness of the documentation.

---

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

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

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

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

CodeRabbit Commands (invoked as PR comments)

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

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

CodeRabbit Configration File (.coderabbit.yaml)

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

Documentation and Community

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