You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Feature functionality
At this time our infos on the GitHub repo, esp. onboarding and contributing instructions, have diverged from the ReadTheDocs docs
We need to unify docs location and cross-references so the info is consistent and updates unambiguous.
Existing markdown instructions on this repo should be ported to .rst and moved to doc/. Updates to our README.md should be automatically picked up in docs/introduction.rst. And so on.
This is a mid-term goal. I think it's OK if it doesn't get solved immediately, as long as the solution no longer involves manual porting from GitHub to ReadTheDocs and viceversa.
The text was updated successfully, but these errors were encountered:
Related
#1186
Feature functionality
At this time our infos on the GitHub repo, esp. onboarding and contributing instructions, have diverged from the ReadTheDocs docs
We need to unify docs location and cross-references so the info is consistent and updates unambiguous.
Existing markdown instructions on this repo should be ported to .rst and moved to
doc/
. Updates to our README.md should be automatically picked up indocs/introduction.rst
. And so on.This is a mid-term goal. I think it's OK if it doesn't get solved immediately, as long as the solution no longer involves manual porting from GitHub to ReadTheDocs and viceversa.
The text was updated successfully, but these errors were encountered: