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: Update documentation #1880

Merged
merged 4 commits into from
Jun 26, 2023
Merged

Docs: Update documentation #1880

merged 4 commits into from
Jun 26, 2023

Conversation

JacobCoffee
Copy link
Member

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

Description

This PR updates various documentation:

  • adds simplified getting started on the docs main page
  • updates image and badges in the pypi readme
  • updates badges in the readme
  • updates 'whats new in v2' in the docs

Close Issue(s)

Closes #1849

- docs: adds simplified getting started on the docs main page
- docs(pypi): updates image and badges
- docs(readme): updates badges
- docs: updates 'whats new in v2'
@JacobCoffee JacobCoffee requested a review from a team as a code owner June 25, 2023 04:13
@JacobCoffee
Copy link
Member Author

JacobCoffee commented Jun 25, 2023

This has a commented-out section in the classifiers until pypa/trove-classifiers#148 is implemented. We should also update v1.x branch with this once it is ready, along with the changes to do PyPI-seperate readme to fix the styling issues..

@JacobCoffee JacobCoffee requested a review from provinzkraut June 25, 2023 18:15
@JacobCoffee
Copy link
Member Author

@provinzkraut wdyt?

@github-actions
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/1880

@JacobCoffee JacobCoffee merged commit 8f4d11a into litestar-org:main Jun 26, 2023
@JacobCoffee JacobCoffee deleted the docs_updates branch June 26, 2023 04:03
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

Successfully merging this pull request may close these issues.

Docs: Update classifiers for PyPI
4 participants