Skip to content

Commit

Permalink
fix(docs): fix the issue of docs bug (#10994)
Browse files Browse the repository at this point in the history
## Description

Closes: #10928 




---

### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] 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.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
  • Loading branch information
gsk967 committed Jan 21, 2022
1 parent eb5b11b commit 628547c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/core/proto-docs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!--
order: 14
-->
# Protobuf Documentation

This file has been replaced by [Cosmos-SDK Buf Proto-docs](https://buf.build/cosmos/cosmos-sdk/docs/main)
6 changes: 3 additions & 3 deletions docs/core/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 5

A store is a data structure that holds the state of the application. {synopsis}

### Pre-requisite Readings
## Pre-requisite Readings

- [Anatomy of a Cosmos SDK application](../basics/app-anatomy.md) {prereq}

Expand Down Expand Up @@ -232,7 +232,7 @@ Additional information about state streaming configuration can be found in the [

When `KVStore.Set` or `KVStore.Delete` methods are called, `listenkv.Store` automatically writes the operations to the set of `Store.listeners`.

# New Store package (`store/v2`)
## New Store package (`store/v2`)

The SDK is in the process of transitioning to use the types listed here as the default interface for state storage. At the time of writing, these cannot be used within an application and are not directly compatible with the `CommitMultiStore` and related types.

Expand Down Expand Up @@ -274,6 +274,6 @@ This store can optionally be configured to use a different backend database inst

`store/v2/smt.Store` maps values into a Sparse Merkle Tree (SMT), and supports a `BasicKVStore` interface as well as methods for cryptographic proof generation.

# Next {hide}
## Next {hide}

Learn about [encoding](./encoding.md) {hide}

0 comments on commit 628547c

Please sign in to comment.