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

Update / improve documentation #189

Open
glass-ships opened this issue Sep 13, 2024 · 2 comments
Open

Update / improve documentation #189

glass-ships opened this issue Sep 13, 2024 · 2 comments

Comments

@glass-ships
Copy link
Member

It seems like the existing documentation may be somewhat out of date, or may have some areas which can be improved, particularly where installation is concerned.

We may also want to double check for and look over (or create) a section/page for developing/contributing

@bmaranville
Copy link
Member

I like "somewhat out of date". It's very kind.

@bmaranville
Copy link
Member

bmaranville commented Sep 13, 2024

And there is indeed a contributing page, but it's maybe a little hard to find: https://github.com/reflectometry/refl1d/blob/master/doc/getting_started/contributing.rst

I make this statement with evidence, since the developer who just reorganized the entire codebase still didn't find it.

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

2 participants