Skip to content

Commit

Permalink
docs: improving docs (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekristen committed Jan 30, 2024
1 parent 722c540 commit abdc3d8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To add another integration test, you will need to do the following:

1. Create a new file in the `resources/` directory called `<resource>_test.go`
2. Add the following code to the file: (replace `<resource>` with actual resource name)
```go
```go
//go:build integration
package resources
Expand Down
19 changes: 16 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
site_name: AWS Nuke
site_url: https://ekristen.github.io/aws-nuke
site_author: Erik Kristensen
site_description: >-
AWS Nuke is a tool to clean up your AWS account by nuking (deleting) all resources within it.
repo_name: ekristen/aws-nuke
repo_url: https://github.com/ekristen/aws-nuke
edit_uri: ""

copyright: Copyright &copy; 2024 - Erik Kristensen

site_dir: public

Expand Down Expand Up @@ -30,10 +35,18 @@ theme:
icon: material/toggle-switch-off
name: Switch to system preference
features:
- navigation.footer
- navigation.indexes
- navigation.path
- navigation.sections
#- navigation.tabs
- toc.follow
- toc.integrate
- navigation.path
- content.code.annotate
- content.code.copy
- content.tooltips
- search.highlight
- search.share
- search.suggest

# Plugins
plugins:
Expand Down

0 comments on commit abdc3d8

Please sign in to comment.