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

Move README content to Sphinx documentation #3

Open
glesica opened this issue Oct 7, 2021 · 0 comments
Open

Move README content to Sphinx documentation #3

glesica opened this issue Oct 7, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@glesica
Copy link
Contributor

glesica commented Oct 7, 2021

Most of the content in the README ought to move to the Sphinx documentation (see docs/). The docs are written in RST format, there is a concise tutorial available for this. Pay attention to organization, we want clear "paths" through the documentation for different kinds of users:

  • New BAGEL developers
  • Benchmark developers
  • Benchmark tests (tool developers, etc.)
  • People who want help interpreting results

We can also copy content from the slide deck into the documentation.

@glesica glesica added the documentation Improvements or additions to documentation label Oct 7, 2021
@glesica glesica self-assigned this Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant