Skip to content

Commit

Permalink
Add tip to documentation for docserver
Browse files Browse the repository at this point in the history
  • Loading branch information
JPrevost committed Jun 27, 2024
1 parent 20d9510 commit 68f6de2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,7 @@ To see a current list of commands, run `make help`.

`make docserver` will start a `yard` server using the RDoc comments from the codebase. RDoc in this application is a work-in-progress and should improve over time. As of this writing, the index page generated contains broken links to our markdown documentation, but they "files" navigation displays them properly.

> [!TIP]
> Prior to running `make docserver` the first time, you must install the bundled gems for this application using either `bundle install` or `make install` (they both do the same thing!).
[Class Diagram](docs/reference/classes.md)

0 comments on commit 68f6de2

Please sign in to comment.