Browse Source

fix docs links, remove narratives index page

master
eharkins 1 year ago
parent
commit
2d9353a78d
  1. 2
      docs/customise-client/requests.md
  2. 4
      docs/introduction/how-to-run.md
  3. 4
      docs/narratives/how-to-write.md
  4. 14
      docs/narratives/index.rst

2
docs/customise-client/requests.md

@ -1,7 +1,7 @@
# Requests Made from the Client
The Auspice client will make a number of requests to various endpoints, which this document aims to provide an overview of.
Some of these are dependent on the [build-time customisations](../customise-client/introduction.md) in use, and we plan to allow more flexibility here using this mechanism.
Some of these are dependent on the [build-time customisations](./api) in use, and we plan to allow more flexibility here using this mechanism.
## Requests to the Auspice Server

4
docs/introduction/how-to-run.md

@ -49,7 +49,7 @@ This is needed in three cases:
1. You have installed Auspice from source, or updated the source code.
1. You are editing the source code and need to rebuild the client
1. You wish to build a customised version of the Auspice client.
See [Customising Auspice](../customise-client/introduction.md) for more info.
See [Customising Auspice](../customise-client/index) for more info.
## `auspice develop`
@ -112,7 +112,7 @@ This format includes:
### Narratives
For narratives, please see [Writing a Narrative](../narratives/how-to-write) for a description of the file format.
For narratives, please see [Writing a Narrative](https://docs.nextstrain.org/en/latest/tutorials/narratives-how-to-write.html) for a description of the file format.
## Obtaining a Set of Input Files

4
docs/narratives/how-to-write.md

@ -39,7 +39,7 @@ abstract: "This narrative is going to test the potential of the Auspice narrativ
```
The really important bit here is the `dataset` line -- this references the dataset we downloaded above.
(A [current limitation](narratives/introduction.md##nown-bugs-limitations) of narratives is that they cannot change the dataset.)
(A [current limitation](../guides/communicate/narratives-intro.html#known-bugs-limitations) of narratives is that they cannot change the dataset.)
## Step 3: View the Narrative so Far
@ -116,7 +116,7 @@ have a Methionine (`M`) at this position, while aqua nodes indicate Isoleucine (
## Step 6: Upload Your Example to the Nextstrain Community to Share with Everyone
In the [narratives introduction](http://localhost:3000/auspice/narratives/introduction#sharing-narratives) we introduced the possibility of using the community functionality of Nextstrain to share your narratives.
In the [narratives introduction](../guides/communicate/narratives-intro.html#sharing-narratives) we introduced the possibility of using the community functionality of Nextstrain to share your narratives.
> A quick reminder of the difference between Auspice & nextstrain.org is warranted.

14
docs/narratives/index.rst

@ -1,14 +0,0 @@
======================================
Communicating Results Using Narratives
======================================
This page shouldn't be rendered & should jump to the first TOC entry instead. TODO.
.. toctree::
:hidden:
:maxdepth: 0
:titlesonly:
introduction
how-to-write
create-pdf
Loading…
Cancel
Save