Skip to content

Commit e0a4bb0

Browse files
committed
migrate getting started docs into user guide, make default landing page
1 parent 1cf8205 commit e0a4bb0

File tree

2 files changed

+14
-24
lines changed

2 files changed

+14
-24
lines changed

docs/guide/index.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,6 @@
22

33
Welcome to the Binary Ninja User Guide. You'll notice two menus here. On the right is the table of contents for this main page of the user manual. On the left are links to larger topics that have their own pages, including:
44

5-
- [Plugins](plugins.md)
6-
- [Settings](settings.md)
7-
- [Projects](projects.md)
8-
- [Troubleshooting](troubleshooting.md)
9-
- [Objective-C](objectivec.md)
10-
- [Debugger](debugger/index.md)
11-
- [Migration Guide](migration/index.md)
12-
- [Types](types/index.md)
13-
[comment]: <> (When changing this list, make sure to update mkdocs.yml as well)
14-
155
## Directories
166

177
Binary Ninja stores information in two primary locations. The first is the binary path (wherever Binary Ninja is installed) and the second is the user folder for user-installed content.

mkdocs.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ theme:
3737
- navigation.tracking
3838
- navigation.tabs
3939
- navigation.tabs.sticky
40-
- navigation.sections
4140
- navigation.expand
42-
- navigation.prune
41+
- navigation.indexes # Consider revisiting this later if top-levels being clickable isn't obvious
4342
- navigation.top
4443
- content.code.copy
4544
- search.highlight
45+
- toc.follow
4646

4747
shortcuts:
4848
help: 191 # ?
@@ -65,6 +65,7 @@ plugins:
6565
enabled: !ENV [VALIDATE, False]
6666
- redirects:
6767
redirect_maps:
68+
'index.md': 'getting-started.md'
6869
'guide/debugger.md': 'guide/debugger/index.md'
6970
'guide/remote-debugging.md': 'guide/debugger/remote-debugging.md'
7071
'guide/dbgeng-ttd.md': 'guide/debugger/dbgeng-ttd.md'
@@ -82,17 +83,16 @@ markdown_extensions:
8283
permalink: True
8384

8485
nav:
85-
- Home: 'index.md'
86-
- Getting Started: 'getting-started.md'
87-
# When updating here make sure to update guide/index.md as well
88-
- User Guide:
89-
- 'guide/index.md'
90-
- Plugins: 'guide/plugins.md'
91-
- Settings: 'guide/settings.md'
92-
- Projects: 'guide/projects.md'
93-
- Enterprise: 'guide/enterprise/index.md'
94-
- Troubleshooting: 'guide/troubleshooting.md'
95-
- Objective-C (Experimental): 'guide/objectivec.md'
86+
- User Documentation:
87+
- Getting Started: 'getting-started.md'
88+
- User Guide:
89+
- 'guide/index.md'
90+
- Using Plugins: 'guide/plugins.md'
91+
- All Settings: 'guide/settings.md'
92+
- Projects: 'guide/projects.md'
93+
- Enterprise: 'guide/enterprise/index.md'
94+
- Troubleshooting: 'guide/troubleshooting.md'
95+
- Objective-C (Experimental): 'guide/objectivec.md'
9696
- Debugger:
9797
- Overview: 'guide/debugger/index.md'
9898
- Remote Debugging: 'guide/debugger/remote-debugging.md'
@@ -113,7 +113,7 @@ nav:
113113
- Debug Info: 'guide/types/debuginfo.md'
114114
- Platform Types: 'guide/types/platformtypes.md'
115115
- C++ Types: 'guide/types/cpp.md'
116-
- Developer Guide:
116+
- Developer Documentation:
117117
- 'dev/index.md'
118118
- Cookbook: 'dev/cookbook.md'
119119
- Writing Plugins: 'dev/plugins.md'

0 commit comments

Comments
 (0)