From abdc3d888eb766bcaf4baf64a935cbfa998e9b39 Mon Sep 17 00:00:00 2001 From: Erik Kristensen Date: Tue, 16 Jan 2024 17:04:23 -0700 Subject: [PATCH] docs: improving docs (#24) --- docs/testing.md | 2 +- mkdocs.yml | 19 ++++++++++++++++--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/testing.md b/docs/testing.md index 26a31752a..6a30e5f0a 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -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 `_test.go` 2. Add the following code to the file: (replace `` with actual resource name) - ```go + ```go //go:build integration package resources diff --git a/mkdocs.yml b/mkdocs.yml index 50ab06dbc..0b0849e6e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 © 2024 - Erik Kristensen site_dir: public @@ -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: