From 2628530a37069bd737f9aade72f4d7e9cc21b547 Mon Sep 17 00:00:00 2001 From: Atanas Atanasov Date: Thu, 7 Nov 2024 13:55:30 +0200 Subject: [PATCH] some nitpicks Signed-off-by: Atanas Atanasov --- README.md | 5 ++--- docs/{README.md => overview.md} | 5 +++-- 2 files changed, 5 insertions(+), 5 deletions(-) rename docs/{README.md => overview.md} (84%) diff --git a/README.md b/README.md index d4bd0f3f8..4c523951c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Implementation of the Hedera Block Node, which is responsible for consuming the [![Latest Version](https://img.shields.io/github/v/tag/hashgraph/hedera-block-node?sort=semver&label=version)](README.md) [![Made With](https://img.shields.io/badge/made_with-java-blue)](https://github.com/hashgraph/hedera-block-node/) -[![Development Branch](https://img.shields.io/badge/docs-quickstart-green.svg)](docs/README.md) +[![Development Branch](https://img.shields.io/badge/docs-quickstart-green.svg)](docs/overview.md) [![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE) ## Prerequisites @@ -40,10 +40,9 @@ Implementation of the Hedera Block Node, which is responsible for consuming the - `suites`: A set of e2e tests that can be used to verify the correctness of the block node. - `tools`: A set of command line tools for working with block stream files. - ## Getting Started -Refer to the [Hedera Block Node Documentation Overview](docs/README.md) for more information about the project, design and guides. +Refer to the [Hedera Block Node Documentation Overview](docs/overview.md) for more information about the project, design and guides. ## Support diff --git a/docs/README.md b/docs/overview.md similarity index 84% rename from docs/README.md rename to docs/overview.md index f39c90b19..018e76e01 100644 --- a/docs/README.md +++ b/docs/overview.md @@ -4,14 +4,15 @@ This document will outline the structure and content of Block Node documentation ## Table of Contents -1. [Introduction](#introduction) +1. [Projects](#projects) 1. [Concepts](#concepts) 1. [Release](#release) -## Introduction +## Projects - [Hedera Block Node](../server/README.md): Provides an introduction to Hedera Block Node, its purpose and how it can be used. - [Simulator](../simulator/README.md): Offers instructions on how the Simulator can be utilized. +- [Tools](../tools/README.md): Provides information on the command line tools available. ## Concepts