Skip to content

add grid class documentation #559

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

Merged
merged 10 commits into from
Jan 18, 2024
Merged

add grid class documentation #559

merged 10 commits into from
Jan 18, 2024

Conversation

trebor
Copy link
Contributor

@trebor trebor commented Jan 17, 2024

add documentation for the grid CSS classes. i'm not sure if we want to use the js echo for the example code.

image

i worry that that it will nudge them to use the hypertext literal when they might not need to. i could duplicate the example code into fenced blocks and not use echo, but then we have two copies of the code.

here is how the full page renders.

image

@trebor trebor requested review from allisonhorst, cinxmo and Fil January 17, 2024 23:28
@trebor
Copy link
Contributor Author

trebor commented Jan 18, 2024

i've updated the example code to match the style in #561 now looks like:

image

Copy link
Contributor

@allisonhorst allisonhorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes in comments, I think this will be a popular page!

@allisonhorst allisonhorst mentioned this pull request Jan 18, 2024
9 tasks
@trebor trebor requested a review from allisonhorst January 18, 2024 02:20
Copy link
Contributor

@Fil Fil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a sentence needs clarification


To see these examples change dynamically, adjust the page width or collapse the sidebar on the left.

As with any CSS provided by the CLI, you can mix in standard CSS to customize pages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand this sentence (or its purpose).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you've highlighted two sentences here, i assume you are referring to the second sentence. my intent there is to highlight to novice users that they are not limited to the css classes we provide, but now that you mention it, it does seem unnecessary. i have removed it. :)

the first sentence is for folks with narrow screens who might not see 4 column grids as 4 columns without hiding the sidebar.

trebor and others added 5 commits January 18, 2024 08:37
Co-authored-by: Philippe Rivière <[email protected]>
Co-authored-by: Philippe Rivière <[email protected]>
Co-authored-by: Philippe Rivière <[email protected]>
Co-authored-by: Philippe Rivière <[email protected]>
@trebor trebor requested a review from Fil January 18, 2024 16:47
@trebor
Copy link
Contributor Author

trebor commented Jan 18, 2024

@Fil i'm merging this up into components so you will have another crack at there as that PR lands.

@trebor trebor merged commit bd9691c into components Jan 18, 2024
@trebor trebor deleted the trebor/grid-docs branch January 18, 2024 17:56
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.

3 participants