Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
* Add FAQs for common user questions such as sample size, security questions, etc
* Add more guidance for data preparation
* Aim all contact questions at helpdesk and update staff list
* Fix available API params and include missing options
* Update API examples to run as written (both curl and python versions) + update example payloads to reflect current structure
* Hide docker and "create reference panels" documentation, to reflect that TIS is a more focused service
* Remove reference panels not supported on TIS; replace with link to MIS docs
* Add readthedocs config files (mandatory as of Sept 2023)
  • Loading branch information
abought committed Jun 27, 2023
1 parent 74bca1b commit bced89c
Show file tree
Hide file tree
Showing 11 changed files with 239 additions and 287 deletions.
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

mkdocs:
configuration: mkdocs.yml
fail_on_warning: false
Loading

1 comment on commit bced89c

@avsmith
Copy link

@avsmith avsmith commented on bced89c Sep 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See few comments inline. Not any major issues, but pointed to a few minor fixes

Please sign in to comment.