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

Simplify README.md and move detailed docs to user guides #1562

Open
harrism opened this issue May 13, 2024 · 0 comments
Open

Simplify README.md and move detailed docs to user guides #1562

harrism opened this issue May 13, 2024 · 0 comments
Labels
doc Documentation

Comments

@harrism
Copy link
Member

harrism commented May 13, 2024

In #1552 it is noted that the level of detail in README.md is quite high and growing. We should consider moving a lot of the detailed usage instructions for both C++ and Python APIs to the corresponding user guides.

Original comment:

My only question is whether README.md is getting too big. Maybe this belongs in the Python docs instead? e.g. guide.md?

Arguably yes, a question then arises as to whether we want to do a split properly. Right now, some of the information in README is replicated in the python guide. AFAICT, the README is the "canonical" source of user documentation for the C++ API, I don't know if we would rather incorporate it into the doxygen docs.

Originally posted by @wence- in #1552 (comment)

@harrism harrism added the doc Documentation label May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant