search

project-bluebird / simurgh

An open source platform that supports developing and evaluating algorithms (AI agents) for air traffic control
https://alan-turing-institute.github.io/simurgh
11 stars 4 forks source link

Project website #23

Closed evelinag closed 4 years ago

evelinag commented 4 years ago

New jekyll-based website for the project, removing mkdocs for documentation

radka-j commented 4 years ago

Looks good to me! Some minor comments below :)

Do we maybe want to reduce the main README to the bare essentials and direct people the docs from there? At the moment a lot of the content is duplicated. And it seems that the repo's main purpose is to hold the docs and examples - so the README doesn't have to be as substantial?

For the developers guide, these instructions are actually old and won't work as we removed the submodules from the repo. I would go with advising ppl to go to the repo of each of the subprojects if they want to contribute code, and just keep instructions on how to contribute to the overall docs in simurgh. Although feel free to disagree!

The project structure (in docs.md) and project overview (in getting_started.md) are pretty much the same. Would it make sense to cut down the project overview section?