Skip to content

Commit

Permalink
Add: Algorithms and Coverage Env Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pedro2712 committed May 1, 2024
1 parent d093bdb commit 60c2147
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 222 deletions.
42 changes: 25 additions & 17 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export default defineConfig({
items: [
{
collapsed: true,
text: 'Training Environment',
text: 'Search Environment',
items: [
{ text: 'About', link: '/docs#about' },
{ text: 'Quick Start', link: '/docs#quick-start' },
Expand All @@ -55,22 +55,30 @@ export default defineConfig({
]
},

// {
// collapsed: true,
// text: 'Coverage Environment',
// items: [
// { text: 'Item A da Seção A', link: '...' },
// { text: 'Item B da Seção B', link: '...' },
// ]
// }
// {
// collapsed: true,
// text: 'Algorithms',
// items: [
// { text: 'Item A da Seção A', link: '...' },
// { text: 'Item B da Seção B', link: '...' },
// ]
// }
{
collapsed: true,
text: 'Coverage Environment',
items: [
{ text: 'About', link: '/docsCoverage#about' },
{ text: 'Quick Start', link: '/docsCoverage#quick-start' },
{ text: 'General Info', link: '/docsCoverage#general-info' },
{ text: 'Built in Functions', link: '/docsCoverage#built-in-functions' },
{ text: 'Person Movement', link: '/docsCoverage#person-movement' },
{ text: 'License', link: '/docsCoverage#license' },
]
},
{
collapsed: true,
text: 'Algorithms',
items: [
{ text: 'About', link: '/docsAlgorithms#about' },
{ text: 'Quick Start', link: '/docsAlgorithms#quick-start' },
{ text: 'General Info', link: '/docsAlgorithms#general-info' },
{ text: 'Built in Functions', link: '/docsAlgorithms#built-in-functions' },
{ text: 'Person Movement', link: '/docsAlgorithms#person-movement' },
{ text: 'License', link: '/docsAlgorithms#license' },
]
}
]
}
],
Expand Down
16 changes: 0 additions & 16 deletions docs/about.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/buildInFunctions.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Drone Swarm Search project is an environment, based on PettingZoo, that is t

| If target is found | If target is not found |
:-------------------------:|:-------------------------:
| ![](https://raw.githubusercontent.com/PFE-Embraer/drone-swarm-search/main/docs/pics/victory_render.png) | ![](https://raw.githubusercontent.com/PFE-Embraer/drone-swarm-search/main/docs/pics/fail_render.png) |
| ![](https://raw.githubusercontent.com/PFE-Embraer/drone-swarm-search/main/docs/public/pics/victory_render.png) | ![](https://raw.githubusercontent.com/PFE-Embraer/drone-swarm-search/main/docs/public/pics/fail_render.png) |


## Quick Start
Expand Down
86 changes: 0 additions & 86 deletions docs/environment.md

This file was deleted.

76 changes: 0 additions & 76 deletions docs/generalInfo.md

This file was deleted.

12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"devDependencies": {
"@types/node": "^20.12.5",
"gh-pages": "^6.1.1",
"vitepress": "^1.1.3"
"vitepress": "^1.1.4"
}
}

0 comments on commit 60c2147

Please sign in to comment.