mkdocs.yml

# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#

site_name: Hyperledger Fabric
site_url: http://hyperledger-fabric.readthedocs.io
theme: readthedocs
repo_url: https://github.com/hyperledger/fabric.git
site_description: 'Welcome to the Hyperledger fabric documentation'
strict: true
theme_dir: 'docs/custom_theme'

pages:
- Home: index.md
- Key Concepts:
  - Overview: overview.md
  - Why Fabric: whyfabric.md
  - Use Cases: biz/usecases.md
  - Glossary: glossary.md
  - Transaction Data Model: data_model.md
  - Security Model: security_model.md
  - Multi Channel: multichannel.md
  - Chaincode: smartcontract.md
  - Consensus: consensus.md

- Getting Started:
  - Network Components: included.md
  - Setting up: asset_setup.md
  - Asset Transfer through SDK: asset_sdk.md
  - Using the CLI: asset_cli.md
  - Troubleshooting: asset_trouble.md

- Application Interfaces:
  - Node.js SDK: nodesdk.md
  - Java SDK: javasdk.md
  - Python SDK: pythonsdk.md

- Running Demos:
  - Marbles: marbles.md
  - Art Auction: auction.md
  - CP Paper: paper.md
  - Car Lease: carlease.md

- Tutorials:
  - Understanding chaincode basics: chaincode.md
  - Learn chaincode: learn_chaincode.md
  - Understanding docker compose: dockercompose.md
  - Sample application: sampleapp.md
  - Developer videos: videos.md
  - Administration and operations: adminops.md
  - Debugging: debug.md
  - Logging Control: Setup/logging-control.md

- Configuration Considerations:
  - Best Practices: recipes.md
  - Starting a network: bootstrap.md

- Architecture:
  - Overview: architecture.md
  - Deep Dive: arch-deep-dive.md
  - Peer Nodes:
    - Endorsers: endorser.md
    - Committers: committer.md
  - Policies & System Chaincode: endorsement-policies.md
  - Ordering Service: orderingservice.md
  - Pluggable Implementations: pluggableos.md
  - Ledger: ledger.md
  - Gossip: gossip.md
  - Security & Cryptography: Setup/ca-setup.md
  - Components: components.md
  - Read/Write Set Semantics: readwrite.md
  - Transaction Flow: txflow.md

- Getting Help:
  - Troubleshooting: troubleshooting.md

- Appendix:
  - Release notes: releases.md
  - Contributing: CONTRIBUTING.md
  - Development Process and Code:
    - Getting an account: Gerrit/lf-account.md
    - Maintainers: MAINTAINERS.md
    - Navigating JIRA: jira_navigation.md
    - Fabric developer setup: dev-setup/devenv.md
    - Building fabric: dev-setup/build.md
    - Gerrit: Gerrit/gerrit.md
    - Committing code: Gerrit/changes.md
    - Reviewing code: Gerrit/reviewing.md
    - Best practices: Gerrit/best-practices.md
    - Testing process: testing.md
  - Style Guides:
    - Golang: Style-guides/go-style.md
  - Still Have Questions?: questions.md
  - Criteria on quality: quality.md
  - Status: status.md
  - License: license.md

markdown_extensions:
  - toc:
     permalink: true
  - admonition
  - extra
  - tables
  - toc
  - fenced_code
  - smarty
  - mdx_math:
      enable_dollar_delimiter: True #for use of inline $..$
  - footnotes

copyright: <br></br>Contributed to the Hyperledger Project under the <a href="https://github.com/hyperledger/fabric/blob/master/LICENSE" target="_blank">Apache Software License 2.0</a>