dandi / dandi/dandi-cli

Create custom domain for Read the Docs site

Open
#1,563 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
28
Forks
37
Avg merge
1d 17h
Merged PRs (30d)
9

Description

## Issue description

Given the recent updates to the website routes (see https://github.com/dandi/dandi.github.io/issues/84) and particularly the renaming of the DANDI Handbook to `docs.dandiarchive.org`, as @yarikoptic points out it is confusing that we have a `dandi` RTD site for the DANDI Client.

## Possible solution

I propose that we create a custom domain for the RTD site and use `docs.dandiarchive.org/api/client` or `docs.dandiarchive.org/client`. RTD allows for [custom domains](https://docs.readthedocs.io/en/stable/guides/custom-domains.html) but we will need to investigate further if we can use a custom domain that also includes a path (e.g. `/api/client`).

If we agree on this being the solution, I would be happy to work on this. I will just need the credentials for the `dandi` RTD account.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.