From 9141b7025a07a52a9119d22dbaca0562a9e2172f Mon Sep 17 00:00:00 2001 From: Nigel Jones Date: Sat, 9 Mar 2024 15:50:05 +0000 Subject: [PATCH] Update index.md - remove tasks already done & update introduction --- docs/index.md | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-) diff --git a/docs/index.md b/docs/index.md index a546a52..932b9b6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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