Skip to content

Commit

Permalink
Fix broken links to Developer Guide in docs (#432)
Browse files Browse the repository at this point in the history
Update links to Developer Guide in README.md and LearningOutcomes.md.
  • Loading branch information
limmlingg authored and yamgent committed May 24, 2017
1 parent cc22ed6 commit d0272c5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#### Site Map
* [User Guide](docs/UserGuide.md)
* [Developer Guide](docs/DeveloperGuide.md)
* [Developer Guide](docs/DeveloperGuide.adoc)
* [Learning Outcomes](docs/LearningOutcomes.md)
* [About Us](docs/AboutUs.md)
* [Contact Us](docs/ContactUs.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/LearningOutcomes.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ After studying this code and completing the corresponding exercises, you should

## Use High-Level Designs `[LO-HighLevelDesign]`

Note how the [Developer Guide](DeveloperGuide.md#architecture) describes the high-level design using an
Note how the [Developer Guide](DeveloperGuide.adoc#architecture) describes the high-level design using an
_Architecture Diagrams_ and high-level sequence diagrams.

------------------------------------------------------------------------------------------------------

## Use Event-Driven Programming `[LO-EventDriven]`

Note how the [Developer Guide](DeveloperGuide.md#architecture) uses events to communicate with components
Note how the [Developer Guide](DeveloperGuide.adoc#architecture) uses events to communicate with components
without needing a direct coupling. Also note how the `EventsCenter` class acts as an event dispatcher to
facilitate communication between event creators and event consumers.

Expand Down Expand Up @@ -69,7 +69,7 @@ Note how the AddressBook app uses Java `assert`s to verify assumptions.

## Use Logging `[LO-Logging]`

Note [how the AddressBook app uses Java's `java.util.log` package to do logging](DeveloperGuide.md#31-logging).
Note [how the AddressBook app uses Java's `java.util.log` package to do logging](DeveloperGuide.adoc#31-logging).

**Resources**

Expand Down Expand Up @@ -223,7 +223,7 @@ the entire system end-to-end.
## Automate GUI Testing `[LO-AutomateGuiTesting]`

Note how this project uses TextFX library to automate GUI testing, including
[_headless_ GUI testing](DeveloperGuide.md#headless-gui-testing).
[_headless_ GUI testing](DeveloperGuide.adoc#headless-gui-testing).

#### Exercise: Write more automated GUI tests
* Add some more automated GUI tests.
Expand All @@ -242,7 +242,7 @@ Here are some example design patterns used in the code base.
Facade class.
* **Command Pattern** : The [`Command.java`](../src/main/java/seedu/address/logic/commands/Command.java) and its
sub classes implement the Command Pattern.
* **Observer Pattern** : The [event driven mechanism](DeveloperGuide.md#events-driven-nature-of-the-design) used by
* **Observer Pattern** : The [event driven mechanism](DeveloperGuide.adoc#events-driven-nature-of-the-design) used by
this code base employs the Observer pattern.<br>
For example, objects that are interested in events need to have the `@Subscribe` annotation in the class (this is
similar to implementing an `<<Observer>>` interface) and register with the `EventsCenter`. When something noteworthy
Expand Down

0 comments on commit d0272c5

Please sign in to comment.