Skip to content

Commit 816e34e

Browse files
tac0turtletac0turtle
andauthored
chore: remove cli docs (#2217)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview this pr removes the cli docs as its specific to testapp and user apps could contain different cmds not covered here this pr also fixes buf check ci job <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **Chores** - Removed the CLI documentation generation command and related workflow from the project. - Deleted multiple CLI documentation markdown files. - Cleaned up indirect dependencies that are no longer needed. - Updated linting scripts to include additional markdown files in checks. - **Documentation** - Improved formatting and clarity in several README and specification files. - Made minor markdown formatting adjustments for headings, bullet points, and code block types. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: tac0turtle <you@example.com>
1 parent 281ee25 commit 816e34e

42 files changed

Lines changed: 82 additions & 723 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/lint.yml

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -49,27 +49,6 @@ jobs:
4949
- uses: actions/checkout@v4
5050
- uses: rollkit/.github/.github/actions/markdown-lint@v0.5.0
5151

52-
cli-docs-lint:
53-
name: Lint CLI Docs
54-
runs-on: ubuntu-latest
55-
steps:
56-
- uses: actions/checkout@v4
57-
- name: set up go
58-
uses: actions/setup-go@v5
59-
with:
60-
go-version-file: ./go.mod
61-
- name: install rollkit cli
62-
run: make install
63-
- name: Generate Docs
64-
run: testapp docs-gen
65-
- name: Verify no diff
66-
run: |
67-
DIFF=$(git diff)
68-
if [[ -n "$DIFF" ]]; then
69-
echo "$DIFF"
70-
exit 1
71-
fi
72-
7352
# Checks that the .goreleaser.yaml file is valid
7453
goreleaser-check:
7554
runs-on: ubuntu-latest

.github/workflows/proto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
workflow_call:
55
permissions:
66
contents: read
7+
pull-requests: write
78

89
jobs:
910
buf-check:

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ The easiest way to understand how to use Rollkit is by exploring our example imp
1818

1919
Requires Go version >= 1.22.
2020

21-
TestApp is a CLI tool that demonstrates how to run different kinds of nodes using the Rollkit framework. It serves as a reference implementation and helps you understand how to build your own Rollkit-based blockchain.
21+
TestApp is a CLI tool that demonstrates how to run different kinds of nodes using the Rollkit framework.
22+
It serves as a reference implementation and helps you understand how to build your own Rollkit-based blockchain.
2223

2324
#### Install
2425

@@ -43,12 +44,11 @@ You can spin up a local TestApp network (powered by Rollkit) with the following
4344
testapp start
4445
```
4546

46-
Explore the CLI documentation [here](./docs/cmd/testapp.md)
47-
4847
## Building with Rollkit
4948

5049
Rollkit is the first sovereign rollup framework that allows you to launch
51-
a sovereign, customizable blockchain as easily as a smart contract. TestApp serves as a reference implementation to help you get started with your own Rollkit-based blockchain.
50+
a sovereign, customizable blockchain as easily as a smart contract.
51+
TestApp serves as a reference implementation to help you get started with your own Rollkit-based blockchain.
5252

5353
Check out our tutorials on our [website][docs].
5454

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Release Steps
44

5-
* Update config version in [config/defaults.go](https://github.com/rollkit/rollkit/blob/main/config/defaults.go)
5+
* Update config version in [config/defaults.go](https://github.com/rollkit/rollkit/blob/main/pkg/config/defaults.go)
66
* Release new Rollkit version
77
* Update [Rollkit/Cosmos-SDK](https://github.com/rollkit/cosmos-sdk) with the newly released Rollkit version
88
* Release new Rollkit/Cosmos-SDK version

docs/cmd/testapp.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/cmd/testapp_completion.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/cmd/testapp_completion_bash.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

docs/cmd/testapp_completion_fish.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/cmd/testapp_completion_powershell.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/cmd/testapp_completion_zsh.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)