diff --git a/docs/css/my-styles.css b/docs/css/my-styles.css new file mode 100644 index 0000000000..40aba59612 --- /dev/null +++ b/docs/css/my-styles.css @@ -0,0 +1,27 @@ +pre { + background-color: #f8f8f7; +} + +code { + background-color: #0083fb; +} + +/* this doesn't work now +.md-nav__link { + text-transform: uppercase; + color: #0083fb; +} +*/ + +/* Katharine's css additions */ +.md-header, .md-tabs, .md-footer-meta, .md-footer-nav, .md-footer-nav__inner { + background-color: #172b6e; +} + +.md-nav__title { + color: #172b6e; +} + +.md-icon { + ./assets/images/favicon.ico +} \ No newline at end of file diff --git a/docs/ex_rl.md b/docs/ex_rl.md deleted file mode 100644 index 5c6bdd606d..0000000000 --- a/docs/ex_rl.md +++ /dev/null @@ -1,11 +0,0 @@ -# Reinforcement Learning and the AEA Framework - -We provide two examples to demonstrate the utility of our framework to RL developers. - -## Gym Example - -The `train.py` file [here](https://github.com/fetchai/agents-aea/tree/master/examples/gym_ex/train.py) shows that all the RL developer needs to do is add one line of code `(proxy_env = ...)` to introduce our agent as a proxy layer between an OpenAI `gym.Env` and a standard RL agent. The `gym_ex` just serves as a demonstration and helps on-boarding, there is no immediate use case for it as you can train your RL agent without our proxy layer just fine (and faster). However, it decouples the RL agent from the `gym.Env` allowing the two do run in separate environments, potentially owned by different entities. - -## Gym Skill - -The `gym_skill` [here](https://github.com/fetchai/agents-aea/tree/master/examples/gym_skill) lets an RL developer embed their RL agent inside an AEA as a skill. diff --git a/mkdocs.yml b/mkdocs.yml index 8643f4d059..e554f6df08 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,14 +21,25 @@ nav: - Welcome: - "What is the AEA?": 'index.md' - "Architecture": 'architecture.md' - - Quick start: 'quickstart.md' - - CLI: 'cli_overview.md' + - "Version": 'version.md' + - AEA quick start: 'quickstart.md' + - Get developing: + - "Protocol": 'protocol.md' + - "Skill": 'skill.md' + - "Scaffolding": 'scaffolding.md' + - "CLI commands": 'cli_overview.md' + - Integration: + - "Integrate with third parties": 'integration.md' - Demos: - - "Reinforcement Learning": 'ex_rl.md' + - "AEA gym skill": 'gym-skill.md' + - "Gym efficiency demo": 'gym-plugin.md' - "TAC": 'tac.md' markdown_extensions: - pymdownx.superfences - - admonition \ No newline at end of file + - admonition + +extra_css: + - css/my-styles.css \ No newline at end of file