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

Improve docs styling and structure #3300

Open
Blargian opened this issue Feb 20, 2025 · 0 comments
Open

Improve docs styling and structure #3300

Blargian opened this issue Feb 20, 2025 · 0 comments
Labels

Comments

@Blargian
Copy link
Member

Placeholder issue for improvements we can make to docs styling and page structure.

Ideas from discussion with Cristina:

  • Use titles more effectively
  • Use indentation (see BigQuery docs for very effective use of indentation)
  • Add white space between sections, even paragraphs
  • Style certain elements so that they pop up
  • Define a max width of…. 880, test it, see how it goes.
  • Increase the line height of regular text to 175%
  • Experiment with regular text size 16px (we use 14px)
  • get rid of the line rule between sections (makes pages feel like 'boxed' information rather than a narrative)

Examples of documentation with good design that encompass some of the above changes:

https://supabase.com/docs/guides/database/overview
https://vercel.com/docs/observability
https://linear.app/docs/start-guide
https://docs.stripe.com/
https://vuejs.org/guide/introduction.html

@Blargian Blargian added the P2 label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant