Clean up some document titles, added introduction

pendulum-project · Sep 22, 2023 · fab33ee · fab33ee
1 parent 54d8d36
commit fab33ee
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -1,4 +1,4 @@
-# Getting started with ntpd-rs
+# Getting started
 
 Ntpd-rs is an implementation of the NTP protocol. It aims to synchronize your system's clock to time received from the internet. It can also, when [configured as server](server-setup.md), provide time to other machines on the network.
 

diff --git a/docs/guide/server-setup.md b/docs/guide/server-setup.md
@@ -1,4 +1,4 @@
-# Setting up ntpd-rs as an NTP server
+# Setting up an NTP server
 
 By default, ntpd-rs only acts as an ntp client, and doesn't serve time on any
 network interface. To enable nptd-rs as a server, the following can be added to

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,15 @@
 # ntpd-rs
 
 Welcome to ntpd-rs, a full-featured NTP server and client implementation,
-including NTS support.
+including NTS support. The documentation is divided into several sections. For
+new users of ntpd-rs we recommend to start with the [getting started guide][1].
+If you already have experience with other NTP software, you may want to start
+with one of the specific migration guides in the *Guide* section of the
+documentation.
+
+If you are looking for a reference level explanation of functions in ntpd-rs we
+recommend looking at the *Man Pages* section. Finally, if you are looking at how
+ntpd-rs development is organized, please take a look at the *Development*
+section of the documentation.
+
+[1]: ./guide/getting-started.md