Skip to content

Commit 9141b70

Browse files
authored
Update index.md - remove tasks already done & update introduction
1 parent 44a41de commit 9141b70

File tree

1 file changed

+5
-19
lines changed

1 file changed

+5
-19
lines changed

docs/index.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,14 @@
11
# Introduction
22

3-
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.
3+
This repository has been populated with a basic getting-started structure
4+
that we can extend for the PQ code package project.
45

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

7-
## Configuration Updates
8-
9-
### Site Name
10-
11-
Change the `site_name` tag in `mkdocs.yml` to reflect the name of your Hyperledger project.
12-
13-
!!! example
14-
``` yaml
15-
site_name: Hyperledger Bevel
16-
```
17-
18-
### Repo URL
8+
During the Hackathon we can hopefully start building this site.
199

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

22-
!!! example
23-
``` yaml
24-
repo_url: https://github.com/hyperledger/_PROJECT_
25-
```
11+
## Configuration Updates
2612

2713
### Project Logo
2814

0 commit comments

Comments
 (0)