From 20d1c99444fc902bc673b9a98f9af2f77901d5e4 Mon Sep 17 00:00:00 2001 From: Saurav Maheshkar Date: Mon, 20 Mar 2023 02:52:01 +0000 Subject: [PATCH] [refactor] update docs (#3174) * refactor: README-zh-Hans * refactor: REFERENCE * docs: update paths in README --- README.md | 4 ++-- README-zh-Hans.md => docs/README-zh-Hans.md | 0 REFERENCE.md => docs/REFERENCE.md | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename README-zh-Hans.md => docs/README-zh-Hans.md (100%) rename REFERENCE.md => docs/REFERENCE.md (100%) diff --git a/README.md b/README.md index 3b55649b4..5ce18650f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ [![WeChat badge](https://img.shields.io/badge/微信-加入-green?logo=wechat&)](https://raw.githubusercontent.com/hpcaitech/public_assets/main/colossalai/img/WeChat.png) - | [English](README.md) | [中文](README-zh-Hans.md) | + | [English](README.md) | [中文](docs/README-zh-Hans.md) | @@ -399,7 +399,7 @@ We leverage the power of [GitHub Actions](https://github.com/features/actions) t ## Cite Us -This project is inspired by some related projects (some by our team and some by other organizations). We would like to credit these amazing projects as listed in the [Reference List](./REFERENCE.md). +This project is inspired by some related projects (some by our team and some by other organizations). We would like to credit these amazing projects as listed in the [Reference List](./docs/REFERENCE.md). To cite this project, you can use the following BibTeX citation. diff --git a/README-zh-Hans.md b/docs/README-zh-Hans.md similarity index 100% rename from README-zh-Hans.md rename to docs/README-zh-Hans.md diff --git a/REFERENCE.md b/docs/REFERENCE.md similarity index 100% rename from REFERENCE.md rename to docs/REFERENCE.md