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

Update README #116

Merged
merged 8 commits into from
Nov 11, 2022
Merged

Update README #116

merged 8 commits into from
Nov 11, 2022

Conversation

rogermparent
Copy link
Contributor

@rogermparent rogermparent commented Nov 9, 2022

This PR has a few goals

fixes #118, but just barely. We can probably do with more elaboration and formatting.

@rogermparent rogermparent self-assigned this Nov 9, 2022
@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 9, 2022 17:21 Inactive
@rogermparent rogermparent requested a review from a team November 9, 2022 17:22
- customPropertiesConfig: object config passed to `postcss-custom-properties`

- colorModConfig: object config passed to `postcss-color-mod`

Copy link
Contributor

Choose a reason for hiding this comment

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

I think a few other options were added too on #33. Can we also add those, or do we want to add them through another PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll open a draft ticket on the board and assign myself for a follow-up after I'm done with plausible

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, for now I'll add a super-basic list so we at least have them. I'll leave the ticket for more elaboration later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just added the new commands and some more elaboration on others. Still needs some work, but it'll serve as a base.

@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 10, 2022 17:41 Inactive
@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 10, 2022 17:46 Inactive
@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 10, 2022 17:51 Inactive
@rogermparent rogermparent changed the title Remove unused options from README and plugin options schema Rough update of README and plugin options schema Nov 10, 2022
README.md Outdated

- customPropertiesConfig: object config passed to `postcss-custom-properties`
This function will be used to
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this is incomplete.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤦

@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 11, 2022 19:35 Inactive
@rogermparent rogermparent requested a deployment to gatsby-theme-update-rea-ffjbab November 11, 2022 19:53 Abandoned
@rogermparent rogermparent temporarily deployed to gatsby-theme-update-rea-ffjbab November 11, 2022 19:53 Inactive
@rogermparent rogermparent changed the title Rough update of README and plugin options schema Update README Nov 11, 2022
Comment on lines 18 to 20
filesystem: Joi.boolean().default(true),
glossaryDirectory: Joi.string().default(
glossaryPath: Joi.string().default(
path.resolve('content', 'docs', 'user-guide', 'basic-concepts')
Copy link
Contributor Author

Choose a reason for hiding this comment

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

incomplete rename from before

@rogermparent rogermparent merged commit 82652a0 into main Nov 11, 2022
@rogermparent rogermparent deleted the update-readme branch November 11, 2022 19:57
rogermparent added a commit that referenced this pull request Nov 11, 2022
* Remove unused options from README and plugin options schema

* Add new options to the README and actually indent the default options

* Fix formatting and make Default always on top

* Move README

* Finish incomplete item and make postCssPlugins block behave with linter

* Add main header and intro blurb
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.

Document newly added features
2 participants