-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Unify documentation GitHub/ReadTheDocs #1242
Labels
Milestone
Comments
ClaudiaComito
added
enhancement
New feature or request
documentation
Anything related to documentation
workflows
labels
Oct 13, 2023
This issue is stale because it has been open for 60 days with no activity. |
This issue is still open. We now have new jupiter notebooks #1406 in the
|
MyST looks quite interesting |
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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: