Skip to content

New docs #932

@kof

Description

@kof
  • Move all packages docs to /docs
  • Compare the changelog with the docs
  • Update all docs where plugin names are mentioned, plugins order needs to get new extracted plugins into the list
  • Update polyfills list here
  • Create Changelog
  • Default Preset should fetch all syntax files and render on one page?
  • Check all links after moving files

New contents

  • Write v10 migration guide
  • Write Introduction, reduce the main readme.md
  • Rewrite benefits.md
  • CDN links
  • Write tradeoffs.md
  • Update pereformance.md
  • Write Getting Started
  • Write Hello World
  • Write FAQ
  • Write articles.md with a list of all known articles
  • Rewrite and improve or remove links to my medium articles

Structure (inspired by react docs)

Installation

  • Getting Started
  • Setup
  • CDN Links

Main Concepts

  • Introduction
  • Hello World
  • Benefits
  • Tradeoffs

Advanced Guides

  • SSR
  • CSP
  • Performance
  • CLI

API Reference

  • Styles Syntax
    • Core
    • Default Preset
  • JSS
  • React-JSS
  • Styled-JSS
  • Plugins
    • jss-plugin-x
    • jss-plugin-y

Contributing

FAQ

Community

  • Chat
  • Projects
  • Articles
  • Courses
  • Podcasts
  • Examples
  • Videos

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsCode is fine, documentation is not.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions