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 config documentation #2208

Closed
2 tasks
Derranion opened this issue Aug 7, 2022 · 2 comments · Fixed by #2435
Closed
2 tasks

Update config documentation #2208

Derranion opened this issue Aug 7, 2022 · 2 comments · Fixed by #2435
Assignees
Labels
docs packages/docs epic Feature that is too big to fit in one issue
Milestone

Comments

@Derranion
Copy link
Member

  • Update config docs for components.all
  • Add Presets feature docs

Description:
We need to update config docs for 1.5.0 version because we made two big things there:

  1. Added new feature - Feat #1806: Presets for all components & components config structure change.
  2. Made the breaking change by moving componentsAll feature to components.all and componentsPresets to components.presets.
    (More info is here Move componentsAll config and presets into components option #1967)

To help you with that here is the current config structure:

{
  components: {
    all: { ... },
    presets: { ... },
  },
  colors: { ... },
  icons: { ... },
}

Previous structure:

{
  components: { ... },
  componentsAll: { ... },
  componentsPresets: { .. },
  colors: { ... },
  icons: { ... },
}

Tips:
To add components.all docs just rename \ correct this in the docs.

To add Presets docs you could use VaConfig.demo -> Presets as an example, in the 1.5.0 branch.
Also it is possible to use Presets with VaConfig component (local config).

Side note:
You could do this in the end of the 1.5.0 Milestone because there is a chance that I'll add this during free time.

@Derranion Derranion added the docs packages/docs label Aug 7, 2022
@Derranion Derranion added this to the 1.5.0 milestone Aug 7, 2022
@asvae asvae added the epic Feature that is too big to fit in one issue label Sep 2, 2022
@asvae asvae assigned aluarius and unassigned aluarius Sep 22, 2022
@asvae
Copy link
Member

asvae commented Sep 23, 2022

Can we check if all requirements are met in current state and close this? @aluarius

@aluarius
Copy link
Contributor

aluarius commented Sep 23, 2022

Can we check if all requirements are met in current state and close this?

@asva No, current state must be reworked. I'll deal with it today.

aluarius added a commit to aluarius/vuestic-ui that referenced this issue Sep 23, 2022
aluarius added a commit that referenced this issue Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs packages/docs epic Feature that is too big to fit in one issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants