search

elimu-ai / wiki

📄 Project description, planning & documentation.
MIT License
10 stars 4 forks source link

docs: Sunset Crowdsource app #154

Closed jo-elimu closed 4 months ago

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes focus on removing all mentions and links to the elimu.ai Crowdsource Android app. Instead, the documentation now emphasizes using the elimu.ai Webapp for uploading educational content and performing peer reviews. This shift highlights the improved scalability and efficiency achieved through web-based crowdsourcing.

Changes

File Change Summary
SOFTWARE_ARCHITECTURE.md - Removed links and mentions of elimu.ai Crowdsource Android app
- Added links and references to elimu.ai Webapp

Sequence Diagram(s)

No sequence diagrams are needed for these changes as they primarily involve updating documentation to reflect the current focus on the webapp.

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 238fc90c358c353c1b82cedeb53044710f9e88eb and 21e28bc81a4644ae026cb662154c16b60c5de5cd.
Files selected for processing (1) * SOFTWARE_ARCHITECTURE.md (2 hunks)
Additional context used
LanguageTool
SOFTWARE_ARCHITECTURE.md
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM) Context: ...multimedia is kept as small as possible in order to make the distribution easier in locatio... --- [style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”. (BE_ABLE_TO) Context: .../github.com/elimu-ai/webapp), the crowd is able to upload and peer review educational cont... --- [style] ~52-~52: Consider using a different verb to strengthen your wording. (SPEED_UP_ACCELERATE) Context: ... content on the platform, and thus help speed up the expansion to more languages. As an ... --- [style] ~72-~72: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM) Context: ...ce, and execute the installation script in order to automatically install all the Android A... --- [style] ~84-~84: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM) Context: ...collection"> ## Data Collection 📊 In order to measure how well the elimu.ai software ...
Markdownlint
SOFTWARE_ARCHITECTURE.md
6-6: Expected: h2; Actual: h6 (MD001, heading-increment) Heading levels should only increment by one level at a time --- 97-97: Expected: 0; Actual: 2 (MD007, ul-indent) Unordered list indentation --- 98-98: Expected: 0; Actual: 2 (MD007, ul-indent) Unordered list indentation --- 99-99: Expected: 0; Actual: 2 (MD007, ul-indent) Unordered list indentation --- 100-100: Expected: 0; Actual: 2 (MD007, ul-indent) Unordered list indentation --- 13-13: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 29-29: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 35-35: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 48-48: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 54-54: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 81-81: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 91-91: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 6-6: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 15-15: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 31-31: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 37-37: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 44-44: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 50-50: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 56-56: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 83-83: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 93-93: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 7-7: null (MD032, blanks-around-lists) Lists should be surrounded by blank lines --- 23-23: null (MD032, blanks-around-lists) Lists should be surrounded by blank lines --- 59-59: null (MD032, blanks-around-lists) Lists should be surrounded by blank lines --- 105-105: null (MD045, no-alt-text) Images should have alternate text (alt text)
--- 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.` - `@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](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.