Skip to content

Commit

Permalink
Move docs readme to inside docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick-5546 committed Mar 8, 2024
1 parent fb4f51a commit 907a67f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/README.md → docs/current/docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Docs

[![Tests](https://github.com/UBCSailbot/docs/actions/workflows/tests.yml/badge.svg)](https://github.com/UBCSailbot/docs/actions/workflows/tests.yml)

UBCSailbot software team's documentation site. It is meant to be developed in [Sailbot Workspace](https://github.com/UBCSailbot/sailbot_workspace)
UBCSailbot software team's documentation site. It is meant to be developed in [Sailbot Workspace](https://github.com/UBCSailbot/sailbot_workspace){target=_blank}
in conjunction with our other software, but doesn't have to be. There are instructions for both cases below.

## Setup
Expand All @@ -12,7 +10,7 @@ in conjunction with our other software, but doesn't have to be. There are instru
1. Uncomment `docker-compose.docs.yml` in `.devcontainer/devcontainer.json`
2. Rebuild the Dev Container

Refer to [How to run optional programs](https://ubcsailbot.github.io/docs/main/current/sailbot_workspace/how_to/#run-optional-programs)
Refer to [How to work with containerized applications](../sailbot_workspace/how_to.md#work-with-containerized-applications)
for more details.

### Setup By Itself
Expand All @@ -23,7 +21,7 @@ for more details.
git clone https://github.com/UBCSailbot/docs.git
```

2. Manually install [social plugin OS dependencies](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#dependencies)
2. Manually install [social plugin OS dependencies](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#dependencies){target=_blank}

3. Install Python dependencies

Expand All @@ -32,15 +30,15 @@ for more details.
pip install -Ur docs/requirements.txt
```

- Can do this in a [Python virtual environment](https://ubcsailbot.github.io/docs/reference/python/virtual-environments/)
- Can do this in a [Python virtual environment](../../reference/python/virtual-environments.md)

## Run

### Run in Sailbot Workspace

After [setup](#setup-in-sailbot-workspace), the Docs site should be running on port 8000.

Refer to [How to run optional programs](https://ubcsailbot.github.io/docs/main/current/sailbot_workspace/how_to/#run-optional-programs)
Refer to [How to work with containerized applications](../sailbot_workspace/how_to.md#work-with-containerized-applications)
for more details.

### Run By Itself using VS Code
Expand All @@ -58,7 +56,7 @@ mkdocs serve

## Update Dependencies

This site is built using the latest versions of dependencies in [`docs/requirements.txt`](./docs/requirements.txt)
This site is built using the latest versions of dependencies in `docs/requirements.txt`
at the time of the most recent commit to the main branch.
To see exactly how the site will look when deployed, ensure your local dependencies are up to date.

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ nav:
- Overview: current/controller/overview.md
- Custom Interfaces:
- Overview: current/custom_interfaces/overview.md
- Docs:
- Overview: current/docs/overview.md
- Local Pathfinding:
- Overview: current/local_pathfinding/overview.md
- Network Systems:
Expand Down

0 comments on commit 907a67f

Please sign in to comment.