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

docs: Rewrite introduction in README and documentation main page #401

Merged
merged 1 commit into from
Sep 3, 2023

Conversation

stotko
Copy link
Owner

@stotko stotko commented Sep 3, 2023

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.

@stotko stotko added this to the 2.0.0 milestone Sep 3, 2023
@codecov
Copy link

codecov bot commented Sep 3, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (eacf106) 97.40% compared to head (1eb69f4) 97.40%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #401   +/-   ##
=======================================
  Coverage   97.40%   97.40%           
=======================================
  Files          31       31           
  Lines        2581     2581           
=======================================
  Hits         2514     2514           
  Misses         67       67           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stotko stotko merged commit 50530de into master Sep 3, 2023
55 checks passed
@stotko stotko deleted the readme_introduction branch September 3, 2023 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant