Skip to content

Add sales entry to showcases section in repo's main readme (#9837)#9838

Merged
msynk merged 1 commit intobitfoundation:developfrom
msynk:9837-github-readme-showcases-missing-sales
Feb 8, 2025
Merged

Add sales entry to showcases section in repo's main readme (#9837)#9838
msynk merged 1 commit intobitfoundation:developfrom
msynk:9837-github-readme-showcases-missing-sales

Conversation

@msynk
Copy link
Member

@msynk msynk commented Feb 8, 2025

closes #9837

Summary by CodeRabbit

  • Documentation
    • Updated the OSS Showcases section to include a new entry for the Sales application (with its live link).
    • Adjusted the ordering of existing application entries for consistency.

@msynk msynk requested a review from yasmoradi February 8, 2025 10:43
@coderabbitai
Copy link

coderabbitai bot commented Feb 8, 2025

Walkthrough

This pull request updates the OSS Showcases section in the README.md file. It adds a new entry for a Sales application, linked to https://sales.bitplatform.dev, and adjusts the numbering of existing entries for AdminPanel and Todo. The Sales entry is inserted as number 9 while the remaining entries are renumbered to maintain the overall structure.

Changes

File Change Summary
README.md Added a new OSS showcase entry for the Sales application linking to https://sales.bitplatform.dev as entry 9. Renumbered existing entries accordingly (adminpanel.bitplatform.dev: 5→4, adminpanel.bitplatform.cc: 6→5, todo-aot.bitplatform.cc: 7→6, todo-small.bitplatform.cc: 8→7, todo-offline.bitplatform.cc: 9→8).

Assessment against linked issues

Objective Addressed Explanation
Include Sales module in the OSS showcases section in README.md (#9837)

Poem

I'm a hopping rabbit with lines of code so bright,
Adding Sales to showcases—a joyful, lively sight.
Entries rearranged with a skip and a hop,
In the meadow of markdown, the numbers never stop.
With whiskers twitching, I cheer this update just right! 🐇


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (2)

45-46: Table Row Column Count Inconsistency in OSS Showcases

The "Sales" entry added on line 45—and the adjacent "bitplatform" row on line 46—provide only two columns, whereas the table header (lines 40–41) specifies six columns. This mismatch may lead to rendering issues in Markdown. Please add placeholder cells (e.g., "-" or "N/A") for the missing columns if no content is available.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

45-45: Table column count
Expected: 6; Actual: 2; Too few cells, row will be missing data

(MD056, table-column-count)


46-46: Table column count
Expected: 6; Actual: 2; Too few cells, row will be missing data

(MD056, table-column-count)


54-55: Terminology Consistency for "Todo" Branding

Static analysis indicates that the term "Todo" in the list entries (especially on lines 54–55) might be more clear as "To-do" (with a hyphen) if referring to tasks. Please verify that the current usage aligns with the project's branding guidelines and adjust if needed.

🧰 Tools
🪛 LanguageTool

[grammar] ~54-~54: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...ps://todo-small.bitplatform.cc): .NET 9 Todo demo app with smaller download footprin...

(TO_DO_HYPHEN)


[grammar] ~55-~55: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...://todo-offline.bitplatform.cc): .NET 9 Todo demo app with ef-core & sqlite (Azure s...

(TO_DO_HYPHEN)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bba9df1 and 05c272a.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~54-~54: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...ps://todo-small.bitplatform.cc): .NET 9 Todo demo app with smaller download footprin...

(TO_DO_HYPHEN)


[grammar] ~55-~55: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...://todo-offline.bitplatform.cc): .NET 9 Todo demo app with ef-core & sqlite (Azure s...

(TO_DO_HYPHEN)

🪛 markdownlint-cli2 (0.17.2)
README.md

45-45: Table column count
Expected: 6; Actual: 2; Too few cells, row will be missing data

(MD056, table-column-count)


46-46: Table column count
Expected: 6; Actual: 2; Too few cells, row will be missing data

(MD056, table-column-count)

🔇 Additional comments (1)
README.md (1)

48-57: Consistent Renumbering of Showcase Links

The numbered list entries (lines 48–57) have been updated to reflect the new ordering as described in the PR objectives, with the Sales entry now at number 9. Please double-check that all URLs and descriptions are correct.

🧰 Tools
🪛 LanguageTool

[grammar] ~54-~54: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...ps://todo-small.bitplatform.cc): .NET 9 Todo demo app with smaller download footprin...

(TO_DO_HYPHEN)


[grammar] ~55-~55: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...://todo-offline.bitplatform.cc): .NET 9 Todo demo app with ef-core & sqlite (Azure s...

(TO_DO_HYPHEN)

@msynk msynk merged commit dccf7ab into bitfoundation:develop Feb 8, 2025
1 check passed
@msynk msynk deleted the 9837-github-readme-showcases-missing-sales branch February 8, 2025 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing Sales module from the showcases section in the repo's README.md

2 participants