Skip to content

Commit

Permalink
Merge pull request #4287 from sanger/document-documentation-process-i…
Browse files Browse the repository at this point in the history
…n-readme

Update readme with details on documentation process
  • Loading branch information
dasunpubudumal authored Aug 20, 2024
2 parents 485de71 + 3abaae3 commit d4e3dd3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,10 @@ a organisation of 900 people.

## Documentation

In addition to the [externally hosted YARD docs](https://www.rubydoc.info/github/sanger/sequencescape), you can also run a local server:
The Yard documentation is also hosted at [GitHub Pages](https://pages.github.com/) under [https://sanger.github.io/sequencescape/](https://sanger.github.io/sequencescape/).
The documentation is automatically updated via a CI workflow when a merge to master occurs, but you can also trigger it manually against any branch (the branch can be selected using the "Run Workflow" button in the [corresponding action](https://github.com/sanger/sequencescape/actions/workflows/generate_pages.yml)).

To preview this documentation, you can spin up a yard server locally using the following command:

```shell
yard server --reload sequencescape
Expand Down

0 comments on commit d4e3dd3

Please sign in to comment.