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

[Doc] Fix documentation #152

Open
rturrado opened this issue May 22, 2024 · 0 comments
Open

[Doc] Fix documentation #152

rturrado opened this issue May 22, 2024 · 0 comments

Comments

@rturrado
Copy link
Contributor

The README.md just points to ReadTheDocs. But ReadTheDocs has been broken for a long time.

Align with whatever decision we take for libqasm on:

  • what information we want in the README.md, and what in a different place.
  • where we want to host that extra information: ReadTheDocs? Other?.
  • if it were ReadTheDocs, we have to fix them, because they have been broken for a very long time (at least for libqasm and OpenQL). We may be better off doing it from scratch. I think Fer Grooteman is the person who is maintaining the server where RtD is hosted, and the scripts that automate the publishing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant