search

MicroPyramid / Django-CRM

Open Source CRM based on Django
https://bottlecrm.io
MIT License
1.93k stars 882 forks source link

Correct Spelling and Grammar in Documentation #527

Closed cvantienen closed 4 months ago

cvantienen commented 4 months ago

This pull request addresses minor spelling and grammar issues found within the project's documentation and README.md file. These changes are non-intrusive and serve to enhance the overall quality of the project's documentation. No functional modifications have been made.

Thank you for considering this contribution!

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent update in the Django CRM project primarily focuses on correcting typographical errors in the README.md file. These corrections enhance the clarity and professionalism of the documentation, ensuring accurate guidance on creating workspaces, installing system requirements, and exploring APIs.

Changes

File Change Summary
README.md Corrected typos in text about API creation, workspace setup, system requirements, API exploration, dependency viewing, and contact information.

🐇✨ In the garden of code, where the errors do hide, A diligent rabbit with eyes open wide. Spotted the typos, with a swift hop and a fix, Now the docs are quite perfect, no more for to mix! Cheers to clear text, from dusk until dawn, In the README garden, where confusion is gone. 🌟📄

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 150e1ddc95a11417f1d76ae3a8a92ac2ef63dc83 and b33c2ec05e0bf2de743fd4dce100c25625c356aa.
Files selected for processing (1) * README.md (5 hunks)
Additional Context Used
LanguageTool (42)
README.md (42)
Near line 5: Possible spelling mistake found. Context: ...Django-CRM ============ Django CRM is opensource CRM developed on django framework. It h... --- Near line 5: Possible spelling mistake found. Context: ...ango CRM is opensource CRM developed on django framework. It has all the basic feature... --- Near line 7: The official name of this software platform is spelled with a capital “H”. Context: ... contributions and feature requests via github. This is divided into three parts 1. B... --- Near line 10: Unpaired symbol: ‘]’ seems to be missing Context: ...divided into three parts 1. Backend API [Django CRM](https://github.com/MicroPyra... --- Near line 11: Unpaired symbol: ‘]’ seems to be missing Context: ...MicroPyramid/Django-CRM) 2. Frontend UI [React CRM](https://github.com/MicroPyram... --- Near line 12: Unpaired symbol: ‘]’ seems to be missing Context: ...id/react-crm "React CRM") 3. Mobile app [Flutter CRM]("https://github.com/MicroPy... --- Near line 14: Possible spelling mistake found. Context: ...thub.com/MicroPyramid/flutter-crm") ## Runcode Runcode is online developer workspac... --- Near line 16: Possible spelling mistake found. Context: ...croPyramid/flutter-crm") ## Runcode Runcode is online developer workspace. It is cl... --- Near line 16: You might be missing the article “an” here. Context: ...flutter-crm") ## Runcode Runcode is online developer workspace. It is cloud based ... --- Near line 16: This expression is usually spelled with a hyphen. Context: ...de is online developer workspace. It is cloud based simple, secure and ready to code worksp... --- Near line 16: Possible spelling mistake found. Context: ...y configurable coding environment. With runcode you can run django-crm(API) with one-cl... --- Near line 16: Possible spelling mistake found. Context: ...g environment. With runcode you can run django-crm(API) with one-click. - Open below lin... --- Near line 19: Possible spelling mistake found. Context: ...ne-click. - Open below link to create django-crm workspace on [RunCode](https://runcode.... --- Near line 19: Possible spelling mistake found. Context: ...link to create django-crm workspace on [RunCode](https://runcode.io/ "RunCode"). It wil... --- Near line 19: Possible spelling mistake found. Context: .../runcode.io/ "RunCode"). It will create django-crm API [![RunCode](https://runcode-ap... --- Near line 23: You might be missing the article “a” here. Context: ...eact-crm "React CRM") project to create new workspace with runcode. ## Docs Pleas... --- Near line 23: Possible spelling mistake found. Context: ...") project to create new workspace with runcode. ## Docs Please [Click Here](http://d... --- Near line 35: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? Context: ...ompanies - Leads - Accounts - Invoices (todo) - Cases (todo) - Opportunity (todo) #... --- Near line 36: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? Context: ...s - Accounts - Invoices (todo) - Cases (todo) - Opportunity (todo) ## Try for free ... --- Near line 37: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? Context: ...es (todo) - Cases (todo) - Opportunity (todo) ## Try for free [here](https://bottle... --- Near line 39: Unpaired symbol: ‘]’ seems to be missing Context: ...) - Opportunity (todo) ## Try for free [here](https://bottlecrm.io/) ## Install... --- Near line 43: Possible spelling mistake found. Context: .../) ## Installation Guide We recommend ubuntu 20.04. These instructions are verified ... --- Near line 43: Possible spelling mistake found. Context: ...04. These instructions are verified for ubuntu 20.04. #### To install system requirem... --- Near line 67: Possible spelling mistake found. Context: ...>> ~/.zshrc ``` If you want to install postgres, follow https://www.postgresql.org/down... --- Near line 68: Possible spelling mistake found. Context: ...postgresql.org/download/ #### To modify postgresql root password ``` sudo -u postgres psq... --- Near line 75: This sentence does not start with an uppercase letter. Context: ...ate and activate a virtual environment. if you installed and configured virtualenv... --- Near line 76: Possible spelling mistake found. Context: ...onment. if you installed and configured virtualenv wrapper then use the following ``` mkv... --- Near line 76: Consider adding a comma. Context: ...talled and configured virtualenv wrapper then use the following ``` mkvirtualenv ) on Twitter - Ask questions on [Stack Overflow]() - Chat with community [Gitter](
Additional comments not posted (6)
README.md (6)
`19-19`: Correction of the spelling mistake in "create" enhances the clarity of the documentation. --- `23-23`: Correction of spelling mistakes in "create" and "workspace" improves the professionalism and readability of the documentation. --- `45-45`: Correction of the spelling mistake in "requirements" enhances the credibility of the installation instructions. --- `112-112`: Correction of the spelling mistake in "browser" ensures accurate presentation of the URL. --- `124-124`: Correction of the spelling mistake in "dependency" ensures accuracy in the command comment. --- `138-138`: Standardization of the spelling of "customizations" aligns with the general American English style 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.