Scully: Create better docs and update styles

Created on 11 Mar 2020  路  7Comments  路  Source: scullyio/scully

For support the web, we need update all the .MD files from the DOCS folder.

List:

  • [ ] blog
  • [ ] CODE_OF_CONDUCT
  • [ ] getting-started
  • [ ] getting-started_es
  • [ ] issues
  • [ ] learn
  • [ ] plugins
  • [ ] polyfills
  • [ ] pre-requisites
  • [ ] recommended-plugins
  • [ ] release-for-v8
  • [ ] scully
  • [ ] scully-cmd-line
  • [ ] scully-configuration
  • [ ] scully-lib-core
  • [ ] showcase
  • [ ] utils
UI docs documentation

Most helpful comment

I'll help if needed

All 7 comments

@GuzmanPI is the person in charge of this.
Israel you can put some tips in case someone wants to collaborate.
@Villanuevand please talk with Israel for work together.

I'll help if needed

Thx @geromegrignon I'll add the requirements for the docs to be considered as completed ASAP here, and then we can talk in Gitter for the details

Language requirenments:

  • [ ] correct grammar both in English and Spanish
  • [ ] formal language. In other words no slang, use the "you" pronoun

Style requirenments:

  • [ ] Spaces between paragraphs, hedears, links and lists. Use 8px increments where 16px = 1rem
    Note: Ignore the space undeaneath the code card, becaus I will fix the the component. Hence, fixing all those spaces."

@GuzmanPI Can you tell us about the progress?

Almost half of the docs are done, and I'll be done with the rest today. This are the finished files:

  • [x] blog
  • [x] CODE_OF_CONDUCT
  • [x] getting-started
  • [x] issues
  • [x] learn
  • [x] plugins
  • [x] polyfills
  • [x] pre-requisites
  • [x] recommended-plugins
  • [x] release-for-v8
  • [x] scully
  • [x] scully-cmd-line
  • [x] scully-configuration
  • [x] scully-lib-core
  • [x] showcase
  • [ ] utils

This issue can be closed since all docs have been rewritten. I forgot to add the issue to the merged PR.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

xmlking picture xmlking  路  3Comments

Gyrosh picture Gyrosh  路  5Comments

Splaktar picture Splaktar  路  6Comments

skatcat31 picture skatcat31  路  3Comments

msprogramando picture msprogramando  路  5Comments