litestar icon indicating copy to clipboard operation
litestar copied to clipboard

Published 20 hours ago • verified publisher icon litestar-org

Documentation Style Overhaul

Open JacobCoffee opened this issue 1 year ago • 4 comments

Overhaul styling for documentation in 3.x (Can be earlier, but makes sense for big changes). This would actually be done in the org-level repo to be reflected across all projects.

Some options in order of my preference

  • https://github.com/lepture/shibuya 🥇
  • https://github.com/pradyunsg/lutra (very alpha, not ready yet) 🥈
  • https://github.com/withastro/starlight (almost for the lols of starlite -> litestar -> litestar + starlight) 🥉

[!NOTE]
While we are open for sponsoring on GitHub Sponsors and OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar

JacobCoffee avatar Feb 06 '24 03:02 JacobCoffee

I didn't really like the purple background for the code blocks in dark mode in Shibuya. I liked the starlight theme :)

guacs avatar Feb 06 '24 13:02 guacs

@guacs you can use other colors too:

https://shibuya.lepture.com/customisation/colors/

lepture avatar Feb 21 '24 15:02 lepture

@guacs also advanced alchemy uses these, but the latest shibuya moved to a different coloring so it has the default right now.

https://docs.advanced-alchemy.jolt.rs/latest/

but it had custom brand colors for all the things :D

JacobCoffee avatar Feb 21 '24 15:02 JacobCoffee

@guacs you can use other colors too:

https://shibuya.lepture.com/customisation/colors/

Oh that's great. I should have RTFM :D

guacs avatar Feb 22 '24 00:02 guacs

~~This is the closest I can find, so I will drop this here, not sure if there is a different issue for "better docs".~~

A better documentation, I started a new project about 2 months ago and wanted to try litestar instead of FastAPI. I found the documentation messy and frustrating to read so i gave up and went back to FastAPI. This what made flask, FastAPI etc... so appealing, the examples and documentation is amazing.

added https://github.com/orgs/litestar-org/projects/17?pane=issue&itemId=61394671

Alc-Alc avatar Apr 30 '24 02:04 Alc-Alc

I dont think these are in line wit the goal of the documentation style, they deserve maybe their own project with some sub-issues. This is resolved in https://github.com/litestar-org/litestar/pull/3324

JacobCoffee avatar Apr 30 '24 16:04 JacobCoffee