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

Focus the README on end user usage #70

Open
demeringo opened this issue Nov 24, 2024 · 0 comments
Open

Focus the README on end user usage #70

demeringo opened this issue Nov 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@demeringo
Copy link
Contributor

Problem

The README describe current implementation details but does not provide much guidance to end-users (accessing or contributing to the data).

Solution

Extract the technical documentation to a separate file that is linked from the README.

Update the README to focus on the objectives of the project and more importantly how to contribute to the data (using the widget or by directly openning a PR).

Alternatives

Additional context or elements

@demeringo demeringo added the documentation Improvements or additions to documentation label Nov 24, 2024
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