Skip to content

Commit

Permalink
Update index.md - remove tasks already done & update introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
planetf1 authored Mar 9, 2024
1 parent 44a41de commit 9141b70
Showing 1 changed file with 5 additions and 19 deletions.
24 changes: 5 additions & 19 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,14 @@
# Introduction

This repository contains a template that will allow you to quickly bring up a documentation site for Hyperledger _PROJECT_. In general, the template provides suggested topics that should be covered in your documentation; however, you can always add/remove content to fit the needs of the project.
This repository has been populated with a basic getting-started structure
that we can extend for the PQ code package project.

The following changes need to be done to update the documentation for your project.
Some todos remain, see below for the list.

## Configuration Updates

### Site Name

Change the `site_name` tag in `mkdocs.yml` to reflect the name of your Hyperledger project.

!!! example
``` yaml
site_name: Hyperledger Bevel
```

### Repo URL
During the Hackathon we can hopefully start building this site.

Change the `repo_url` tag in `mkdocs.yml` to reflect the repository of your Hyperledger project.

!!! example
``` yaml
repo_url: https://github.com/hyperledger/_PROJECT_
```
## Configuration Updates

### Project Logo

Expand Down

0 comments on commit 9141b70

Please sign in to comment.