Skip to content

Commit 157303c

Browse files
Update README.md
1 parent 76841b5 commit 157303c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,13 @@ For projects hosted outside of ReadTheDocs, the "to" URL should be the URL of th
106106
> From URL: `/standards` \
107107
> To URL: `https://openforcefield.github.io/standards/`
108108
109-
110-
For projects hosted within ReadTheDocs, the project should be [added as a subproject] of `openff-docs` and the "to" URL should be `/projects/projectname`
109+
For projects hosted within ReadTheDocs, the project should be [added as a subproject] of `openff-docs` to add it to the `docs.openforcefield.org` domain, which provides a URL like `docs.openforcefield.org/projects/projectname`. You must be a maintainer of both the new project and the OpenFF Docs project on RTD to make this change:
111110

112111
> Child: `openff-interchange` \
113112
> Alias: `interchange`
114113
114+
Then, redirects can be added to provide `docs.openforcefield.org/projectname`; the "to" URL should be `/projects/projectname`
115+
115116
> Redirect type: `Exact redirect` \
116117
> From URL: `/interchange/$rest` \
117118
> To URL: `/projects/interchange/`

0 commit comments

Comments
 (0)