Skip to content

Commit 23f6aa1

Browse files
committed
User manual cleanup
1 parent e1b5587 commit 23f6aa1

4 files changed

Lines changed: 16 additions & 12 deletions

File tree

docs/_config.yml

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,25 @@
1919
# in the templates via {{ site.myvariable }}.
2020

2121
title: AusMap User Manual
22-
#email: your-email@example.com
2322
description: >- # this means to ignore newlines until "baseurl:"
24-
User manual for the AusMap QGIS plugin.
25-
#baseurl: "" # the subpath of your site, e.g. /blog
23+
User manual for the AusMap QGIS plugin
2624
url: https://wms-engineering.github.io/AusMap/ # the base hostname & protocol for your site, e.g. http://example.com
27-
# twitter_username: jekyllrb
28-
# github_username: jekyll
25+
2926

3027
# Build settings
3128
theme: just-the-docs
32-
# plugins:
33-
# - jekyll-feed
3429

3530

3631
logo: "/assets/images/icon.png"
3732
favicon_ico: "/assets/images/icon.ico"
3833

34+
# Aux links for the upper right navigation
35+
aux_links:
36+
"AusMap on GitHub":
37+
- "https://github.com/WMS-Engineering/AusMap"
38+
39+
nav_enabled: true
40+
3941
# Exclude from processing.
4042
# The following items will not be processed, by default.
4143
# Any item listed under the `exclude:` key here will be automatically added to
@@ -56,4 +58,7 @@ exclude:
5658
- vendor/gems/
5759
- vendor/ruby/
5860

59-
nav_enabled: true
61+
62+
# Test site locally:
63+
# cd docs/
64+
# bundle exec jekyll serve

docs/bug-reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ permalink: /issues/
77

88
# Bug Reports and Feature Requests
99

10-
If you encounter any bugs or have feature requests, please feel free to create an issue in our GitHub repository. We appreciate your feedback!
10+
If you encounter any bugs or have feature requests, please feel free to create an issue in our [GitHub repository](https://github.com/WMS-Engineering/AusMap/issues). We appreciate your feedback!

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Introduction
2+
title: About
33
layout: home
44
nav_order: 1
55
permalink: /
66
---
77

8-
# Introduction
8+
# About
99

1010
AusMap is a QGIS plugin for visualising publicly available Australian geographic data. It gives quick access to a variety of feature sets and map layers provided by Geoscience Australia, the Google Maps Platform and OpenStreetMap. Selecting a desired layer from the AusMap menu will add it to the map canvas with styling and labelling applied. The layers are provided via WMS, WFS, WMTS and XYZ services, which all require an active internet connection.
1111

docs/settings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,3 @@ The additional map layers will now appear in their respective groups inside the
3232
![Custom layers in menu](/assets/images/new_layers_in_menu.png)
3333

3434
To remove the layers from the menu, go back to the options dialog, delete the file path and save.
35-

0 commit comments

Comments
 (0)