docs: Rewrite introduction in README and documentation main page #401
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A good introduction in the
README
and documentation is crucial to get the library's goals, features, and design communicated to users. While our introduction mentions these points, it is a bit wordy and sometimes not easy to immediately grasp. Rewrite it by listing all important aspects briefly in a bullet list. Furthermore, remove redundant parts in the docs version, i.e. the docs main page, and make use of Sphinx design elements.