Skip to content

Commit

Permalink
README.adoc: add site map
Browse files Browse the repository at this point in the history
Allow visitors to navigate to the other documents in the documentation.
  • Loading branch information
pyokagan committed Jul 4, 2018
1 parent fb74fba commit 274dbc9
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
= AddressBook (Level 1)
ifdef::env-github,env-browser[:relfileprefix: docs/]
:toc:
:toc-title:
:toc-placement: preamble
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
endif::[]

* This is a CLI (Command Line Interface) Address Book application *written in procedural fashion*.
* It is a Java sample application intended for students learning Software Engineering while using Java as
Expand All @@ -16,12 +9,16 @@ usually write in data structure modules.
* It can be used to achieve a number of beginner-level <<LearningOutcomes#, Learning Outcomes>> without
running into the complications of OOP or GUI programmings.
== Site Map

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>

== Contributors

The full list of contributors for se-edu can be found https://se-edu.github.io/Team.html[here].

'''''

== Contact Us

* *Bug reports, Suggestions*: Post in our https://github.com/se-edu/addressbook-level1/issues[issue tracker]
Expand Down

0 comments on commit 274dbc9

Please sign in to comment.