github.com/badrootd/celestia-core@v0.0.0-20240305091328-aa4207a4b25d/docs/README.md (about)

     1  ---
     2  title: CometBFT Documentation
     3  description: CometBFT is a blockchain application platform.
     4  footer:
     5    newsletter: false
     6  ---
     7  
     8  # CometBFT
     9  
    10  Welcome to the CometBFT documentation!
    11  
    12  CometBFT is a blockchain application platform; it provides the equivalent
    13  of a web-server, database, and supporting libraries for blockchain applications
    14  written in any programming language. Like a web-server serving web applications,
    15  CometBFT serves blockchain applications.
    16  
    17  More formally, CometBFT performs Byzantine Fault Tolerant (BFT)
    18  State Machine Replication (SMR) for arbitrary deterministic, finite state machines.
    19  For more background, see [What is CometBFT?](introduction/README.md#what-is-cometbft).
    20  
    21  To get started quickly with an example application, see the [quick start guide](guides/quick-start.md).
    22  
    23  To upgrade from Tendermint Core v0.34.x to CometBFT v0.34.x, please see our
    24  [upgrading instructions](./guides/upgrading-from-tm.md).
    25  
    26  To learn about application development on CometBFT, see the
    27  [Application Blockchain Interface](https://github.com/cometbft/cometbft/tree/v0.34.x/spec/abci).
    28  
    29  For more details on using CometBFT, see the respective documentation for
    30  [CometBFT internals](core/), [benchmarking and monitoring](tools/), and
    31  [network deployments](networks/).
    32  
    33  ## Contribute
    34  
    35  To recommend a change to the documentation, please submit a PR. Each major
    36  release's documentation is housed on the corresponding release branch, e.g. for
    37  the v0.34 release series, the documentation is housed on the `v0.34.x` branch.
    38  
    39  When submitting changes that affect all releases, please start by submitting a
    40  PR to the docs on `main` - this will be backported to the relevant release
    41  branches. If a change is exclusively relevant to a specific release, please
    42  target that release branch with your PR.
    43  
    44  Changes to the documentation will be reviewed by the team and, if accepted and
    45  merged, published to <https://docs.cometbft.com> for the respective version(s).
    46  
    47  The build process for the documentation is housed in the
    48  [CometBFT documentation repository](https://github.com/cometbft/cometbft-docs).