From e0a4bb0f8a44bd54bbf66b78c0888bc7c65017b9 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Tue, 18 Mar 2025 16:51:34 -0400 Subject: migrate getting started docs into user guide, make default landing page --- mkdocs.yml | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml index 6e4e339a..a3a21b17 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,12 +37,12 @@ theme: - navigation.tracking - navigation.tabs - navigation.tabs.sticky - - navigation.sections - navigation.expand - - navigation.prune + - navigation.indexes # Consider revisiting this later if top-levels being clickable isn't obvious - navigation.top - content.code.copy - search.highlight + - toc.follow shortcuts: help: 191 # ? @@ -65,6 +65,7 @@ plugins: enabled: !ENV [VALIDATE, False] - redirects: redirect_maps: + 'index.md': 'getting-started.md' 'guide/debugger.md': 'guide/debugger/index.md' 'guide/remote-debugging.md': 'guide/debugger/remote-debugging.md' 'guide/dbgeng-ttd.md': 'guide/debugger/dbgeng-ttd.md' @@ -82,17 +83,16 @@ markdown_extensions: permalink: True nav: - - Home: 'index.md' - - Getting Started: 'getting-started.md' - # When updating here make sure to update guide/index.md as well - - User Guide: - - 'guide/index.md' - - Plugins: 'guide/plugins.md' - - Settings: 'guide/settings.md' - - Projects: 'guide/projects.md' - - Enterprise: 'guide/enterprise/index.md' - - Troubleshooting: 'guide/troubleshooting.md' - - Objective-C (Experimental): 'guide/objectivec.md' + - User Documentation: + - Getting Started: 'getting-started.md' + - User Guide: + - 'guide/index.md' + - Using Plugins: 'guide/plugins.md' + - All Settings: 'guide/settings.md' + - Projects: 'guide/projects.md' + - Enterprise: 'guide/enterprise/index.md' + - Troubleshooting: 'guide/troubleshooting.md' + - Objective-C (Experimental): 'guide/objectivec.md' - Debugger: - Overview: 'guide/debugger/index.md' - Remote Debugging: 'guide/debugger/remote-debugging.md' @@ -113,7 +113,7 @@ nav: - Debug Info: 'guide/types/debuginfo.md' - Platform Types: 'guide/types/platformtypes.md' - C++ Types: 'guide/types/cpp.md' - - Developer Guide: + - Developer Documentation: - 'dev/index.md' - Cookbook: 'dev/cookbook.md' - Writing Plugins: 'dev/plugins.md' -- cgit v1.3.1