From a8314c308bede921c802823e7343c11a09a93828 Mon Sep 17 00:00:00 2001 From: Parag Ekbote Date: Tue, 17 Dec 2024 16:20:32 +0000 Subject: [PATCH] Update docs. --- docs/Getting-Started.md | 2 -- docs/acknowledgement.md | 3 --- docs/contributing.md | 2 +- mkdocs.yml | 10 ++++++++++ 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index df231344d..ea46e9522 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -1,5 +1,3 @@ -## Getting Started - There are a couple of ways to apply Liger kernels, depending on the level of customization required. ### 1. Use AutoLigerKernelForCausalLM diff --git a/docs/acknowledgement.md b/docs/acknowledgement.md index 08a9b3684..2acf35992 100644 --- a/docs/acknowledgement.md +++ b/docs/acknowledgement.md @@ -1,7 +1,4 @@ -## Acknowledgement - - ### Design - [@claire_yishan](https://twitter.com/claire_yishan) for the LOGO design diff --git a/docs/contributing.md b/docs/contributing.md index e70f9b4f0..d24fb884c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -# Contributing to Liger-Kernel + Thank you for your interest in contributing to Liger-Kernel! This guide will help you set up your development environment, add a new kernel, run tests, and submit a pull request (PR). diff --git a/mkdocs.yml b/mkdocs.yml index 1c3754244..ac014c385 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,16 @@ theme: - navigation.footer - toc.follow - navigation.top + - navigation.sections + nav: + - Home: index.md + - Examples: Examples.md + - Getting Started: Getting-Started.md + - High Level APIs: High-Level-APIs.md + - Low Level APIs: Low-Level-APIs.md + - Contributing: contributing.md + - Acknowledgment: acknowledgement.md + - License: license.md palette: # Dark Mode - scheme: slate