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

feat: primary styling content pages #1993

Merged
merged 14 commits into from
Dec 3, 2024
Merged

Conversation

gentaDemnushaj
Copy link
Contributor

ATTENTION! NEW DOCS STRUCTURE
FOR THE NEXT THREE WEEKS, ONLY BRANCH FROM new-docs-structure
OTHERWISE, WAIT UNTIL THE NEW STRUCTURE HAS BEEN RELEASED


Thank you for contributing to the documentation.

Do the changes you have made apply to both Current and Previous versions?

Have you done a trial build to check all new or changed links?

Is there anything else you would like us to know?

This week's exciting advice from the style guide

  • Write your headings in sentence case:

    • A good example
      This is a correct heading.
    • A Bad Example
      This is not a correct heading.

Copy link
Contributor Author

@gentaDemnushaj gentaDemnushaj left a comment

Choose a reason for hiding this comment

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

File structure and names are not final. Might still change

@matteematt matteematt changed the title chore: added intial styling content feat: primary styling content pages Dec 2, 2024
@matteematt matteematt self-assigned this Dec 2, 2024
@matteematt matteematt marked this pull request as ready for review December 2, 2024 17:33
@matteematt
Copy link
Contributor

matteematt commented Dec 2, 2024

this is good enough for the 5th, but it could still do with improving in certain sections

  1. Direct Genesis component styling section I think is perfect, but happy for you to change it as needed
    2.Extending genesis components - I tweaked and fleshed out your first two pages. I wasn’t really sure what your vision was for the next three pages so for now I removed them. You can add that back in a subsequent PR but for now I pulled them out so we can merge this without merging unfinished docs
    3.Design Tokens - this is mostly just copied and tweaked from what is there on the existing docs. It was very out of date because it was using variables configured before the DSC was a think. I fixed all of those bits, but these docs are still not great quality. I think they could do with improving to match the quality of the other sections
  2. All of the keywords and tags need updating, I basically copied and pasted most headers

Slightly longer term

  • We need to add back our advanced concepts section and add into it how to create your own design system etc

</div>

:::tip
When using the DSC on your application it configure the `rapid` design system, which is the default. It can additionally be used to configure design
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When using the DSC on your application it configure the `rapid` design system, which is the default. It can additionally be used to configure design
When using the DSC on your application it configures the `rapid` design system, which is the default. It can additionally be used to configure design


## Component libraries

An additional big advantage of this approach is that it's component library agnostic - you can use this approach when using Genesis syntax, as well as libraries like React and Angular. The code examples in this section will be shown as pure `html` and `css`, and then you can apply it to whichever component library you're using.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
An additional big advantage of this approach is that it's component library agnostic - you can use this approach when using Genesis syntax, as well as libraries like React and Angular. The code examples in this section will be shown as pure `html` and `css`, and then you can apply it to whichever component library you're using.
An additional advantage of this approach is that it's component library agnostic - you can use this approach when using Genesis syntax, as well as libraries like React and Angular. The code examples in this section will be shown as pure `html` and `css`, and then you can apply it to whichever component library you're using.

Or you could say "yuuuuge advantage" like the guy I keep seeing on the news every night


##### **Scenario 1: Extending Genesis Components**
In this scenario, you create a new component by extending an existing Genesis component, such as `RapidButton`. This approach is ideal when you need to build reusable, branded components for your design system.
Copy link
Contributor

Choose a reason for hiding this comment

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

nice, like this scenario idea.

Copy link
Contributor

@patrickoneill-genesis patrickoneill-genesis left a comment

Choose a reason for hiding this comment

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

A few little nitpicks. Nothing "yuuuuge"

@matteematt matteematt merged commit 584d22a into new-doc-structure Dec 3, 2024
@matteematt matteematt deleted the gd/styling branch December 3, 2024 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants