Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): Appmanager readme #23151

Merged
merged 1 commit into from
Jan 2, 2025
Merged

chore(docs): Appmanager readme #23151

merged 1 commit into from
Jan 2, 2025

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Jan 2, 2025 •
edited by coderabbitai bot
Loading

Description

create appmanager readme

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Added comprehensive README for AppManager package
    • Detailed documentation covering key operational flows including genesis initialization, block delivery, transaction validation, querying, and simulation processes
    • Explained system interactions and dependencies for core application management functions

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 2, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request introduces a comprehensive README.md documentation file for the AppManager in the server/v2/appmanager/ directory. The document provides an in-depth explanation of the AppManager's role as a high-level coordinator that manages application state and delegates operations to the State Transition Function (STF). It covers key operational methods such as InitGenesis, ExportGenesis, DeliverBlock, ValidateTx, Simulate, Query, and their interactions with various system components.

Changes

File Change Summary
server/v2/appmanager/README.md Added comprehensive documentation explaining AppManager's functionality, operational methods, and system interactions

Sequence Diagram

sequenceDiagram
    participant Caller
    participant AppManager
    participant STF
    participant Store

    Caller->>AppManager: DeliverBlock
    AppManager->>Store: Access State
    AppManager->>STF: Process Transactions
    STF-->>AppManager: Transaction Results
    AppManager->>Store: Update State
Loading

Possibly related PRs

  • chore(docs): STF readme #23150: STF documentation update with detailed descriptions of transaction processing functions, directly connected to AppManager's documentation

Suggested reviewers

  • kocubinski
  • testinginprod
  • sontrinh16

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.

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.

@github-actions github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 appmanager labels Jan 2, 2025
@tac0turtle tac0turtle marked this pull request as ready for review January 2, 2025 12:27
coderabbitai[bot]
coderabbitai bot reviewed Jan 2, 2025
View reviewed changes
Copy link
Contributor

@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 (4)
server/v2/appmanager/README.md (4)

1-5: Enhance the introduction with additional context

Consider adding:

  • Version compatibility information
  • Where AppManager fits in the overall architecture
  • Key interfaces and their purposes (STF, Store)
 # AppManager Documentation

 The AppManager serves as a high-level coordinator, delegating most operations to the STF while managing state access through the Store interface.

+## Overview
+
+The AppManager is a core component of the Cosmos SDK v2 architecture that:
+- Coordinates between the application's State Transition Function (STF) and state storage
+- Manages versioning and state transitions
+- Provides a clean interface for blockchain operations
+
+### Compatibility
+
+This documentation applies to Cosmos SDK v2.x.x and later versions.
+
 This document outlines the main external calls in the AppManager package, their execution flows, and dependencies.

7-234: Fix markdown formatting for better readability

The document has several markdown formatting issues:

  • Inconsistent list style (using - instead of *)
  • Incorrect list indentation (2 spaces instead of 4)
  • Missing blank lines around headings and lists

Apply these formatting fixes throughout the document:

  1. Replace list markers (-) with asterisks (*)
  2. Use 4 spaces for list indentation
  3. Add blank lines around headings and lists
  4. Ensure the file ends with a single newline

Example:

 ## Table of Contents
+
- [InitGenesis](#initgenesis)
- [ExportGenesis](#exportgenesis)
+
 ### Dependencies
+
* Required Input:
    * Context
    * BlockRequest
🧰 Tools
🪛 Markdownlint (0.37.0)

8-8: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

9-9: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

10-10: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

11-11: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

12-12: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

13-13: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

14-14: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

15-15: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

41-41: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

42-42: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

43-43: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

44-44: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

45-45: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

46-46: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

47-47: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

48-48: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

49-49: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

66-66: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

67-67: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

69-69: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

70-70: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

71-71: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

93-93: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

94-94: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

95-95: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

96-96: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

97-97: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

98-98: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

119-119: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

120-120: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

121-121: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

122-122: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

123-123: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

124-124: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

125-125: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

145-145: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

146-146: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

147-147: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

148-148: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

149-149: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

150-150: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

151-151: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

168-168: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

169-169: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

170-170: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

171-171: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

195-195: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

196-196: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

197-197: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

198-198: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

199-199: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

200-200: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

201-201: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

202-202: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

219-219: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

220-220: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

221-221: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

222-222: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

223-223: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

224-224: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

225-225: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

230-230: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

231-231: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

232-232: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

233-233: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

234-234: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

7-7: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

65-65: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

92-92: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

118-118: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

144-144: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

167-167: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

194-194: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

218-218: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

8-8: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

41-41: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

66-66: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

93-93: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

119-119: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

145-145: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

168-168: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

195-195: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

219-219: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

230-230: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

234-234: null
Files should end with a single newline character

(MD047, single-trailing-newline)

177-192: Enhance Query operation sequence diagram

The Query operation's sequence diagram could be improved by showing:

  • Error handling paths
  • Gas limit validation
  • Cache usage (if applicable)
 ```mermaid
 sequenceDiagram
 participant Caller
 participant AppManager
 participant Store
 participant STF
 Caller->>AppManager: Query(ctx, version, request)
 alt version == 0
 AppManager->>Store: StateLatest()
 else version > 0
 AppManager->>Store: StateAt(version)
 end
 Store-->>AppManager: queryState, error
+alt error != nil
+    AppManager-->>Caller: error
+end
+AppManager->>AppManager: validateGasLimit(gasLimit)
+alt gasLimit exceeded
+    AppManager-->>Caller: error
+end
 AppManager->>STF: Query(ctx, queryState, gasLimit, request)
 STF-->>Caller: response, error

---

`227-234`: **Expand Common Dependencies section with more details**

The Common Dependencies section would be more helpful with detailed explanations of each component.

```diff
 ## Common Dependencies

 All operations depend on:
-Context management
-Error handling
-Gas metering
-State management (Store interface)
-STF interface
+
+### Context Management
+* Provides transaction context and metadata
+* Handles timeouts and cancellation
+
+### Error Handling
+* Standardized error types and codes
+* Error propagation guidelines
+
+### Gas Metering
+* Gas calculation and limits
+* Resource consumption tracking
+
+### State Management (Store Interface)
+* Version management
+* State transitions and snapshots
+
+### STF Interface
+* Core business logic implementation
+* State transition rules
🧰 Tools
🪛 Markdownlint (0.37.0)

230-230: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

231-231: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

232-232: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

233-233: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

234-234: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

230-230: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

234-234: null
Files should end with a single newline character

(MD047, single-trailing-newline)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a9b265 and 8f88d23.

📒 Files selected for processing (1)
  • server/v2/appmanager/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/appmanager/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 Markdownlint (0.37.0)
server/v2/appmanager/README.md

8-8: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

9-9: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

10-10: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

11-11: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

12-12: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

13-13: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

14-14: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

15-15: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

41-41: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

42-42: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

43-43: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

44-44: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

45-45: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

46-46: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

47-47: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

48-48: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

49-49: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

66-66: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

67-67: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

69-69: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

70-70: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

71-71: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

93-93: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

94-94: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

95-95: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

96-96: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

97-97: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

98-98: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

119-119: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

120-120: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

121-121: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

122-122: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

123-123: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

124-124: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

125-125: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

145-145: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

146-146: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

147-147: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

148-148: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

149-149: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

150-150: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

151-151: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

168-168: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

169-169: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

170-170: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

171-171: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

195-195: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

196-196: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

197-197: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

198-198: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

199-199: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

200-200: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

201-201: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

202-202: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

219-219: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

220-220: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

221-221: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

222-222: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

223-223: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

224-224: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

225-225: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

230-230: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

231-231: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

232-232: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

233-233: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

234-234: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

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

(MD007, ul-indent)

7-7: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

65-65: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

92-92: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

118-118: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

144-144: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

167-167: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

194-194: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

218-218: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

8-8: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

41-41: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

66-66: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

93-93: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

119-119: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

145-145: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

168-168: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

195-195: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

219-219: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

230-230: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

234-234: null
Files should end with a single newline character

(MD047, single-trailing-newline)

@tac0turtle tac0turtle added this pull request to the merge queue Jan 2, 2025
Merged via the queue into main with commit 1c6dc34 Jan 2, 2025
74 checks passed
@tac0turtle tac0turtle deleted the marko/am-readme branch January 2, 2025 14:14
@coderabbitai coderabbitai bot mentioned this pull request Jan 4, 2025
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@randygrok randygrok randygrok approved these changes

@testinginprod testinginprod testinginprod approved these changes

@facundomedica facundomedica Awaiting requested review from facundomedica

Assignees

@facundomedica facundomedica

@randygrok randygrok

@testinginprod testinginprod

Labels
C:server/v2 appmanager C:server/v2 Issues related to server/v2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tac0turtle @randygrok @testinginprod @facundomedica