Skip to content

Commit

Permalink
Setup final structure of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nunofachada committed Aug 25, 2023
1 parent 169719a commit fe5f8e2
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 19 deletions.
2 changes: 0 additions & 2 deletions docs/api/index.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/articles/intro.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/articles/toc.yml

This file was deleted.

3 changes: 3 additions & 0 deletions docs/dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Development

To do.
14 changes: 8 additions & 6 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,11 @@
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
"api/**.yml"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
Expand All @@ -44,10 +41,15 @@
],
"output": "_site",
"globalMetadata": {
"_appFooter": "<span>Copyright © 2023 Nuno Fachada and contributors. Generated with <a href=\"https://dotnet.github.io/docfx\">DocFX</a> and <a href=\"https://ovasquez.github.io/docfx-material\">DocFX Material</a>.</span>",
"_appTitle": "LibGameAI",
"_appLogoPath": "images/logo.svg",
"_appFaviconPath": "images/logo.svg",
"_enableSearch": "true"
"_enableSearch": "true",
"_gitContribute": {
"repo": "https://github.com/nunofachada/libgameai"
},
"_gitUrlPattern": "github"
},
"globalMetadataFiles": [],
"fileMetadataFiles": [],
Expand All @@ -56,7 +58,7 @@
"modern",
"templates/material"
],
"postProcessors": [],
"postProcessors": ["ExtractSearchIndex"],
"keepFileLink": false,
"disableGitFeatures": false
}
Expand Down
6 changes: 6 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Usage examples

This page will be expanded in the future. For now, check out LibGameAI being
used in these educational [Game AI Prototypes].

[Game AI Prototypes]:https://github.com/nunofachada/game-ai-prototypes
42 changes: 38 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,38 @@
# This is the **HOMEPAGE**.
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
## Quick Start Notes:
1. Add images to the *images* folder if the file is referencing an image.
# LibGameAI <img src="docs/images/logo.svg" align="right" />

A .NET Standard 2.1 library of AI algorithms for video games with a focus on
education.

## Library components

* [Decision trees](lib/DecisionTrees)
* [Finite state machines](lib/FSMs)
* [N-grams](lib/NGrams)
* [Naive Bayes classifier](lib/NaiveBayes)
* [Path finding algorithms](lib/PathFinding)
* [PCG](lib/PCG)
* [PRNG](lib/PRNG)
* [QRNG](lib/QRNG)
* [Utils](lib/Util)

## Status & Usage

This is very much a work in progress, and should be considered to be at an alpha
stage of development.

This library is currently used in the educational [Game AI Prototypes].

## Reference

If you use or mention this software in your work, please cite the following
reference:

- Fachada, N., Barreiros, F.F., Lopes, P., & Fonseca, M. (2023, August).
Active Learning Prototypes for Teaching Game AI. In *2023 IEEE Conference on
Games (CoG)* (pp. TBD). IEEE.

## License

[MIT](LICENSE)

[Game AI Prototypes]:https://github.com/nunofachada/game-ai-prototypes
12 changes: 8 additions & 4 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
- name: Articles
href: articles/
- name: API Documentation
- name: Home
href: index.md
- name: Usage examples
href: examples.md
- name: Development
href: dev.md
- name: API Reference
href: api/
homepage: api/index.md

0 comments on commit fe5f8e2

Please sign in to comment.