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

Organize guides #39

Open
9 of 18 tasks
idoros opened this issue Jul 17, 2022 · 1 comment
Open
9 of 18 tasks

Organize guides #39

idoros opened this issue Jul 17, 2022 · 1 comment
Assignees
Labels
docs Documentation enhancement New feature or request plan a plan for organizing larger amounts of work

Comments

@idoros
Copy link
Collaborator

idoros commented Jul 17, 2022

The current state of the guides section is out of date and requires a re-thinking and work.

  • list sections in guides full coverage of stylable features and capabilities
  • decide on writing style, tone, and structure
  • handbook
    • introduction
    • classes
    • namespacing
    • custom state
    • runtime
    • import class
    • extend
    • vars (build time & custom properties)
    • templating
    • assets
    • 3rd party
    • style patterns (incorporate patterns into handbook)
    • build
    • optimizations
    • serve side render
    • publish
@idoros idoros added the enhancement New feature or request label Jul 17, 2022
@idoros
Copy link
Collaborator Author

idoros commented Jul 17, 2022

Handbook - planned chapters

vars

  • build vars
  • custom properties

templating

  • formatter
  • mixin

assets

  • url() resolution
  • ~ prefix

3rd party

  • import native CSS
  • interface for non Stylable stylesheets
  • definitely styled

style patterns

  • utility classes
  • reset
  • project commons
    • design system / tokens
  • style variants
  • theme
    • @st-scope

build

  • CLI
  • webpack, rollup...
  • stylable config
  • depth
  • validation
    • build diagnostics
    • d.ts validations

optimization

server side rendering

publishing

  • lib vs app

@idoros idoros added this to Stylable Jul 18, 2022
@idoros idoros moved this to ❓ Triage Required in Stylable Jul 18, 2022
@idoros idoros moved this from ❓ Triage Required to 🎬 Ready for Work in Stylable Jul 18, 2022
@idoros idoros changed the title Organize guides Organize guides + getting started Jul 18, 2022
@tomrav tomrav moved this from 🎬 Ready for Work to ▶️ In Progress in Stylable Jul 20, 2022
@tomrav tomrav mentioned this issue Jul 21, 2022
1 task
@tomrav tomrav changed the title Organize guides + getting started Organize guides Aug 3, 2022
@idoros idoros added docs Documentation plan a plan for organizing larger amounts of work labels Aug 9, 2022
@idoros idoros moved this from ▶️ In Progress to 🎬 Ready for Work in Stylable Aug 29, 2022
@tomrav tomrav moved this from 🎬 Ready for Work to ⏸️ Paused in Stylable Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation enhancement New feature or request plan a plan for organizing larger amounts of work
Projects
None yet
Development

No branches or pull requests

2 participants