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

Inconsistent styles in newer pages #18668

Open
Cherry opened this issue Dec 11, 2024 · 0 comments
Open

Inconsistent styles in newer pages #18668

Cherry opened this issue Dec 11, 2024 · 0 comments
Labels
content:edit Request for content edits documentation Documentation edits product:products product:style-guide product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/

Comments

@Cherry
Copy link
Contributor

Cherry commented Dec 11, 2024

Existing documentation URL(s)

What changes are you suggesting?

Recently the Cloudflare docs were overhauled to Astro/Starlight, which brought a huge wave of improvements to both the DX for contributors, but also UX for consumers in terms of readability and consistency.

Astro/Starlight provides a huge number of components that are used and configured to maintain a consistent style and feel throughout the docs, but when new components are added with bespoke Tailwind (etc.) classes, this breaks some of that consistent look and feel.

Some examples include:

  • spacing/padding
  • borders
  • border radius
  • text colours
  • background colours
  • "pill" badges
  • hover/focus/active states

Many of these are covered in Cloudflare's published style guide, like https://developers.cloudflare.com/style-guide/components/badges/, or implied by the usage of Starlight, but how they're implemented in some of these custom components with unique tailwind classes breaks that ideal:

Compared to similar components like https://github.com/cloudflare/cloudflare-docs/blob/f3ed460f1a44d8c6cde8547e6ce8f944e433995a/src/pages/learning-paths.astro which have implemented similar functionality, but using native Astro/Starlight components like LinkTitleCard, and not hard-coded specific unique Tailwind classes. This way, as these components are improved/iterated on, everything sees benefit, as well as everything remains consistent.

@Cherry Cherry added content:edit Request for content edits documentation Documentation edits labels Dec 11, 2024
@github-actions github-actions bot added product:style-guide product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:products labels Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:edit Request for content edits documentation Documentation edits product:products product:style-guide product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/
Projects
None yet
Development

No branches or pull requests

8 participants