diff --git a/book/features/hypothesis.md b/book/features/hypothesis.md deleted file mode 100644 index b085d28..0000000 --- a/book/features/hypothesis.md +++ /dev/null @@ -1,19 +0,0 @@ -# Hypothesis - -Add this to `_config.yml`. Need to create an account. - - -``` -html: - comments: - hypothesis: true -``` - -```{admonition} Tips -:class: tip - -- use {ref}`remove_from_publish` to enable in Draft book only -- figure out how to use this... -``` - - diff --git a/book/installation-and-setup/extension.md b/book/installation-and-setup/extension.md index 33cc652..022b0fc 100644 --- a/book/installation-and-setup/extension.md +++ b/book/installation-and-setup/extension.md @@ -1,7 +1,22 @@ # Making comments on the website -This section will explain how to use the extension in order to make comments. +This section will explain how to use the extension hypothesis in order to make comments. Firstly, you will need to open your interactive text book in your browser. Take as example the [MUDE](https://mude.citg.tudelft.nl/book/intro.html) book. If you look at the top right of the page, you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension. The extension we are currently using is called Hypothesis. In order to use it you will have to make an account. Through the extension you will be able to highlight relevant sections and write notes and annotations. Comments on the content of the book can be submitted by making annotations and posting them to group called Feedback! + +## Set up hypothesis in your book +Add this to `_config.yml`. Need to create an account. + +``` +html: + comments: + hypothesis: true +``` + +```{admonition} Tips +:class: tip + +- use {ref}`remove_from_publish` to enable in Draft book only +``` \ No newline at end of file