Skip to content

Commit

Permalink
refactor: #57 init mkdocs documentation
Browse files Browse the repository at this point in the history
- use a tool to create the docs

- removes the previous wiki docs
  • Loading branch information
miguelcsx committed Sep 1, 2024
1 parent 8614423 commit c3ceeb3
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
[submodule "docs"]
path = docs
url = [email protected]:miguelcsx/aura.wiki.git
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ AURA is a chatbot and virtual study assistant designed to facilitate and enhance

This provides a convenient and familiar login method for users who are already active on Discord.

## Goals

The primary goal of AURA is to create an intelligent and adaptive study assistant that utilizes modern learning techniques and technologies to enhance the educational experience. By providing a personalized, engaging, and data-driven approach, AURA aims to help students achieve better learning outcomes and long-term knowledge retention.

## Usage

To use AURA, follow these steps:
Expand Down
1 change: 0 additions & 1 deletion docs
Submodule docs deleted from f339d3
17 changes: 17 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site_name: My Docs

0 comments on commit c3ceeb3

Please sign in to comment.