Skip to content

Commit

Permalink
docs: update navs paths and fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
gvauter committed Aug 27, 2024
1 parent 3100c5e commit 58f8f33
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
14 changes: 1 addition & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# trestle-bot
# Overview

[![Pre commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![License](https://img.shields.io/badge/license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
Expand Down Expand Up @@ -61,15 +61,3 @@ Container images are available in `quay.io`:
```bash
podman run -v $(pwd):/data -w /data quay.io/continuouscompliance/trestle-bot:<tag>
```

## Contributing

For information about contributing to trestle-bot, see the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE) file for details.

## Troubleshooting

See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for troubleshooting tips.
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
site_name: trestle-bot
site_description: Documentation for trestle-bot.
repo_name: trestle-bot
repo_url: https://github.com/RedHatProductSecurity/trestle-bot/

theme:
name: material
Expand All @@ -24,6 +27,8 @@ theme:
name: Switch to light mode

markdown_extensions:
- markdown_include.include
- md_in_html
- toc:
toc_depth: 2
- pymdownx.superfences:
Expand All @@ -34,3 +39,15 @@ markdown_extensions:

copyright: |
&copy; Copyright 2023 Red Hat, Inc.</a>
nav:
- Overview:
- QuickStart: index.md
- Architecture:
- Diagrams: architecture/diagrams/c4.md
- Tutorials:
- GitHub: tutorials/github.md
- Troubleshooting: troubleshooting.md
- Contributing: contributing.md


0 comments on commit 58f8f33

Please sign in to comment.