Skip to content

Conversation

@augustocollado
Copy link
Contributor

Description

Debt from a previously merged PR

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this page requires a disclaimer, I have added one
  • If pages have been moved around, I have created an additional PR in tanssi-mkdocs to update redirects

@augustocollado augustocollado requested a review from a team as a code owner October 14, 2025 11:26
@Copilot Copilot AI review requested due to automatic review settings October 14, 2025 11:26
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the formatting of list items in documentation to use a new consistent format. The changes replace hyphen-separated descriptions with colon-separated descriptions and add periods at the end of each list item.

  • Changed list item format from "Term - description" to "Term: description."
  • Applied consistent punctuation by adding periods to all list items
  • Updated formatting across multiple documentation files

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
llms-full.txt Updated list formatting for node operators, developers, networks, sequencers, and cost categories
llms-files/llms-substrate-template.txt Applied new list format to match main documentation
llms-files/llms-sequencers.txt Updated list formatting for consistency
llms-files/llms-rpc-data-preservers.txt Applied new list format to match main documentation
llms-files/llms-operators.txt Updated list formatting for consistency
llms-files/llms-evm-template.txt Applied new list format to match main documentation
llms-files/llms-custom-runtime.txt Updated list formatting for consistency
llms-files/llms-basics.txt Applied new list format to match main documentation
llms-files/llms-appchain.txt Updated list formatting for consistency
learn/tanssi/network-services/block-production.md Applied new list format to the main documentation file

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link

Style Guide Violations Summary

learn/tanssi/network-services/block-production.md (Line 26)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Node operators**: who run sequencers, offering their block production services to get rewards

learn/tanssi/network-services/block-production.md (Line 27)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Developers**: who launch networks, which require sequencers

learn/tanssi/network-services/block-production.md (Line 123)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Networks**: teams can focus on the core logic of their product, the UX, and the UI without dealing with the challenges of infrastructure bootstrapping and its management

learn/tanssi/network-services/block-production.md (Line 124)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Sequencers**: bearing with the responsibility of keeping their hardware and software configuration in optimal conditions, they are incentivized to execute transactions and produce blocks on behalf of the Tanssi networks

learn/tanssi/network-services/block-production.md (Line 132)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Registration deposit**: the initial deposit that is locked from the account that signs the network registration transaction

learn/tanssi/network-services/block-production.md (Line 133)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Registration storage deposit**: the initial deposit that is locked from the account that signs the network registration transaction. It is a variable amount depending on the appchain's runtime size

learn/tanssi/network-services/block-production.md (Line 134)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Sequencers assignment**: every time the Tanssi protocol assigns sequencers, which happens once per session, a fixed fee is charged. This fee gives networks the right to be assigned sequencers and discourages networks whose runtime logic fails to produce valid transactions or blocks

learn/tanssi/network-services/block-production.md (Line 135)

  • Issue:
    List item ends with period, but should not per style guide (items not starting with verb should not have terminal punctuation)

  • Correction:

+ **Block production**: networks must pay for each block produced on their behalf. Since the protocol selects and assigns the sequencers on a per-session basis, networks must have enough funds to cover all the blocks to be produced in an entire session to be served

@github-actions
Copy link

Verification Review

This review focuses on style guide claims, justifications, and confidence scores in the provided documents.


learn/tanssi/network-services/block-production.md (Line 129)

  • Claim:
    every time the Tanssi protocol assigns sequencers, which happens once per session, a fixed fee is charged

  • Context:

Sequencers assignment: every time the Tanssi protocol assigns sequencers, which happens once per session, a fixed fee is charged. This fee gives networks the right to be assigned sequencers and discourages networks whose runtime logic fails to produce valid transactions or blocks

  • Justification:

Claims specific protocol behavior (session frequency and fee structure) that requires confirmation against current implementation

  • Requires Verification: Yes
  • Confidence Score: 0.85

Copy link
Collaborator

@0xlukem 0xlukem left a comment

Choose a reason for hiding this comment

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

Thanks for addressing this 🫶. I left a few comments. The new list format is
** Term **: Description. You can check it out in here

@augustocollado
Copy link
Contributor Author

Thanks for addressing this 🫶. I left a few comments. The new list format is ** Term **: Description. You can check it out in here

Oh, I wasn't aware that we were also doing caps now. ty

@0xlukem 0xlukem added the A3 - Quick Fixes Pull request contains small fixes (i.e., fixing a typo, removing old images, etc.) label Oct 14, 2025
Copy link
Collaborator

@0xlukem 0xlukem left a comment

Choose a reason for hiding this comment

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

🚀

@0xlukem 0xlukem added the B1 - Ready to Merge Pull request is ready to be merged label Oct 14, 2025
@augustocollado augustocollado merged commit bf71cd6 into main Oct 23, 2025
3 checks passed
@augustocollado augustocollado deleted the augustocollado/lists branch October 23, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A3 - Quick Fixes Pull request contains small fixes (i.e., fixing a typo, removing old images, etc.) B1 - Ready to Merge Pull request is ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants