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

New docs #932

Open
12 of 18 tasks
kof opened this issue Dec 9, 2018 · 8 comments
Open
12 of 18 tasks

New docs #932

kof opened this issue Dec 9, 2018 · 8 comments
Labels
docs Code is fine, documentation is not.
Milestone

Comments

@kof
Copy link
Member

kof commented Dec 9, 2018

  • 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
@kof kof added the docs Code is fine, documentation is not. label Dec 9, 2018
@HenriBeck HenriBeck mentioned this issue Dec 9, 2018
13 tasks
@kof kof pinned this issue Dec 14, 2018
@eps1lon
Copy link
Member

eps1lon commented Jan 10, 2019

Removing the readmes from the packages does have the downside that you won't have any displayed on npmjs.org: https://www.npmjs.com/package/jss-plugin-vendor-prefixer

The individual package.json also don't have a repo listed at the moment which again causes trouble with npmjs.org. Packages usually have a link to their repository on their page on npmjs.org.

Just wanted to let you know in case this was not intended.

@HenriBeck
Copy link
Member

Good catch. I think we should just copy the docs when releasing but ignore them in git.

@HenriBeck
Copy link
Member

Also, we should remove all of the version which are <= 9 from the dropdown on the docs page because you end up at a NotFound page

@kof
Copy link
Member Author

kof commented Jan 21, 2019

Regarding readme.md, lets do the same thing as babel: https://www.npmjs.com/package/@babel/plugin-syntax-export-namespace-from

Regarding docs: its broken right now. My original plan was to publish the 9th version as a subdomain and when dropdown selects v9, switch to that subdomain. I am not sure though its worth the effort and maybe we should just remove v9 from the docs.

cc @oliviertassinari

@HenriBeck
Copy link
Member

👍
I will create a script for creating the readme then

@kof
Copy link
Member Author

kof commented Jan 21, 2019

@HenriBeck its not a full readme, its just title, link to the docs on the website and install steps. I think it is manually created for each package.

@HenriBeck
Copy link
Member

HenriBeck commented Jan 21, 2019

Yeah, we can automate that 🤔

Just generate them before the release and they don't even need to be in git
I would like to do the same with the licenses inside the packages

@kof
Copy link
Member Author

kof commented Jan 21, 2019

I think you want them to be in git even if you generate them, for the case someone lands there over github link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code is fine, documentation is not.
Projects
None yet
Development

No branches or pull requests

3 participants