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

Break down styles.css into separate components files #3463

Closed
berezinant opened this issue Jan 22, 2024 · 1 comment · Fixed by #3917
Closed

Break down styles.css into separate components files #3463

berezinant opened this issue Jan 22, 2024 · 1 comment · Fixed by #3917
Assignees
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format
Milestone

Comments

@berezinant
Copy link
Contributor

According to the spike for decomposing styles.css we need to break down styles into separate components to enhance maintainability of styles, simplify development and adding UI components from design

@berezinant berezinant self-assigned this Jan 22, 2024
@berezinant berezinant added enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format labels Jan 23, 2024
@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Jan 26, 2024

Looks like this issue can also be broken down into two parts:

  1. (simple) Just physically break down styles.css into smaller component-like files. We already have comments in styles.css that act as "component sections", so we can use that as a starting point. Here, no renaming, no actual refactoring of the styles and thus no breaking changes are expected.
  2. (difficult) Start renaming styles to adhere to the new conventions and linting rules, and additionally break down or extract styles to improve maintainability, simplify development and adding of new UI components. This part is difficult because it has a high chance of breaking something, and it might require changes inside Dokka's base plugin (to rename classes, generate additional divs and so on).

Because the second part is difficult, time consuming and needs additional discussion, this issue should focus on the first part.

@whyoleg whyoleg added this to the Dokka 2.0.0 milestone Dec 16, 2024
@whyoleg whyoleg closed this as completed Dec 16, 2024
@whyoleg whyoleg linked a pull request Dec 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants