contribute.jquery.org icon indicating copy to clipboard operation
contribute.jquery.org copied to clipboard

Published 20 hours ago • verified publisher icon jquery

Create Prose Style Guide

Open scottgonzalez opened this issue 11 years ago • 17 comments
trafficstars

Most of http://learn.jquery.com/style-guide/ should be moved here as the prose style guide spans everything from READMEs to API documentation to articles and tutorials.

The index page will need to be updated as well, as that links to the various existing guides.

scottgonzalez avatar Apr 15 '14 12:04 scottgonzalez

Hi @scottgonzalez, how to can I contribute on this?

marti1125 avatar May 07 '14 11:05 marti1125

To start, you should read through http://contribute.jquery.org/ and http://learn.jquery.com/style-guide/. Then you could send a PR with a first draft.

scottgonzalez avatar May 07 '14 14:05 scottgonzalez

(everything from READMEs to API documentation to articles and tutorials) I am new, where are READMEs =? could you give me the links?

marti1125 avatar May 07 '14 16:05 marti1125

READMEs are in all of the various repositories. To be honest, a large part of this task requires the knowledge of someone immersed in this community.

scottgonzalez avatar May 07 '14 16:05 scottgonzalez

@scottgonzalez well I will try with this https://github.com/jquery/sizzle it is ok?

marti1125 avatar May 07 '14 17:05 marti1125

@marti1125 You might want to start with the one at https://github.com/jquery/api.jquery.com/blob/master/README.md

Let me know if you have any questions about it.

kswedberg avatar May 07 '14 17:05 kswedberg

I need some confirmation.

Do you wish to have the information in http://learn.jquery.com/style-guide/ distributed inside pages at http://contribute.jquery.org/ ?

pablofiumara avatar Aug 05 '14 13:08 pablofiumara

The style guide needs to move out of the various locations that it currently exists, including http://learn.jquery.com/style-guide/, and into http://contribute.jquery.org/style-guide/prose/.

scottgonzalez avatar Aug 05 '14 13:08 scottgonzalez

Thanks for your answer.

I will send you a pull request with a first draft in the next few days.

pablofiumara avatar Aug 05 '14 13:08 pablofiumara

@pablofiu That's great. If you have any questions, just ask here or in #jquery-content on IRC.

scottgonzalez avatar Aug 05 '14 13:08 scottgonzalez

Thank you, Scott.

pablofiumara avatar Aug 05 '14 13:08 pablofiumara

I have just sent you a pull request jquery/contribute.jquery.org#87 There, you will see a draft of the solution to issue jquery/contribute.jquery.org#75

pablofiumara avatar Aug 11 '14 18:08 pablofiumara

See https://github.com/jquery/learn.jquery.com/issues/285 for more details.

scottgonzalez avatar Dec 24 '14 13:12 scottgonzalez

With regards to code output placement, we agreed to use // > on its own line. We might then choose to replace this with whatever we decide is more suitable on build (e.g. ➡ or → or something else) otherwise, keep >, see https://github.com/jquery/globalize/issues/313

agcolom avatar Mar 11 '15 14:03 agcolom

Slightly related: Markdown "code" style is something else I'd like to document one day. Do we want new lines under headings, hard wrapping, how do we make lists, ...

arthurvr avatar Jul 24 '15 17:07 arthurvr

Adding a note here regarding the use of instead of " " in the api docs where appropriate. (From today's content meeting)

agcolom avatar Sep 23 '15 17:09 agcolom

Recommendations for README content: https://the-pastry-box-project.net/charlotte-spencer/2015-september-16

Some tools that we might be able to integrate:

  • http://www.hemingwayapp.com/ - Editor hat helps write short and simple english
  • http://alexjs.com/ - Catch insensitive, inconsiderate writing
  • http://joblint.org/ - Test tech job posts for issues with sexism, culture, expectations, and recruiter fails.

jzaefferer avatar Oct 18 '15 20:10 jzaefferer