chore(docs): converting architecture diagram to ascii

[madflojo]

Summary by CodeRabbit

• Documentation
  • Added an architecture diagram to the README for the Example Airport Lookup Application, illustrating the interactions between various components and external services.

[coderabbitai]

Walkthrough

The recent update to the docs/README.md introduces an architecture diagram for the Example Airport Lookup Application. This diagram illustrates the interactions between various Tarmac components, including the Tarmac Host, WebAssembly Engine, and functions such as Init, Load, Fetch, and Lookup. It also shows the connections to external services like Consul, Prometheus, Redis, and MySQL, providing a clear visual representation of the application's architecture.

Changes

Files	Change Summary
docs/README.md	Added an architecture diagram for the Example Airport Lookup Application, detailing interactions between Tarmac components and external services.

🐇 In the land of code, where logic does flow,
A diagram was born, for all to know.
Tarmac and engines, functions that gleam,
With Redis and MySQL, they form a team.
Prometheus watches, Consul stands by,
In the Airport Lookup's digital sky.
✈️

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

• Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
• Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
• Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

• Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
• Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
• High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
• Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

---

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.

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (3)

docs/README.md (3)

Line range hint 13-13: Consider adding a hyphen to "key/value stores" to maintain consistency with common usage: "key-value stores".

---

214-214: Remove the extra blank line to maintain a clean and consistent document structure.

---

Line range hint 230-230: Ensure all images have appropriate alternate text to improve accessibility.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 445d394 and 49fb454.

Files selected for processing (1)

• docs/README.md (1 hunks)

Additional Context Used

LanguageTool (1)

docs/README.md (1)

Near line 13: This expression is ususally spelled with a hyphen
Context: ...ch to application frameworks. Tarmac is language agnostic and offers built-in support for key/val...
Rule ID: SPECIFIC_HYPHEN

Markdownlint (36)

docs/README.md (36)

27: Column: 1
Hard tabs

---

28: Column: 1
Hard tabs

---

34: Column: 1
Hard tabs

---

36: Column: 1
Hard tabs

---

37: Column: 1
Hard tabs

---

38: Column: 1
Hard tabs

---

39: Column: 1
Hard tabs

---

40: Column: 1
Hard tabs

---

46: Column: 1
Hard tabs

---

48: Column: 1
Hard tabs

---

49: Column: 1
Hard tabs

---

51: Column: 1
Hard tabs

---

52: Column: 1
Hard tabs

---

53: Column: 1
Hard tabs

---

54: Column: 1
Hard tabs

---

55: Column: 1
Hard tabs

---

56: Column: 1
Hard tabs

---

57: Column: 1
Hard tabs

---

58: Column: 1
Hard tabs

---

59: Column: 1
Hard tabs

---

60: Column: 1
Hard tabs

---

61: Column: 1
Hard tabs

---

63: Column: 1
Hard tabs

---

64: Column: 1
Hard tabs

---

65: Column: 1
Hard tabs

---

66: Column: 1
Hard tabs

---

67: Column: 1
Hard tabs

---

68: Column: 1
Hard tabs

---

69: Column: 1
Hard tabs

---

71: Column: 1
Hard tabs

---

72: Column: 1
Hard tabs

---

214: Expected: 1; Actual: 2
Multiple consecutive blank lines

---

79: null
Dollar signs used before commands without showing output

---

80: null
Dollar signs used before commands without showing output

---

94: null
Dollar signs used before commands without showing output

---

230: null
Images should have alternate text (alt text)

Additional comments not posted (1)

docs/README.md (1)

163-211: The ASCII architecture diagram is a creative and clear representation of the system's architecture.