Skip to content
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

Open
ClaudiaComito opened this issue Oct 13, 2023 · 3 comments
Open

Unify documentation GitHub/ReadTheDocs #1242

ClaudiaComito opened this issue Oct 13, 2023 · 3 comments
Labels
documentation Anything related to documentation enhancement New feature or request workflows
Milestone

Comments

@ClaudiaComito
Copy link
Contributor

ClaudiaComito commented Oct 13, 2023

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 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.

@ClaudiaComito ClaudiaComito added enhancement New feature or request documentation Anything related to documentation workflows labels Oct 13, 2023
@ClaudiaComito ClaudiaComito added this to the 1.5.0 milestone Oct 13, 2023
Copy link
Contributor

This issue is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale label Dec 18, 2023
@ClaudiaComito
Copy link
Contributor Author

This issue is still open.

We now have new jupiter notebooks #1406 in the tutorials directory. What still needs to be done here:

@mtar
Copy link
Collaborator

mtar commented Mar 27, 2024

MyST looks quite interesting
https://myst-parser.readthedocs.io/en/latest/index.html#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation enhancement New feature or request workflows
Projects
None yet
Development

No branches or pull requests

2 participants