Curated explanations require a style guide

[siobhan]

To ensure that curated explanations in the code reference are consistent we need some sort of style guide.

This should be created and posted to the docs handbook. It should be linked to from the admin screen in the code reference.

See: ​http://irclogs.wordpress.org/chanlog.php?channel=wordpress-sfd&day=2014-09-09&sort=asc#m134058

[siobhan]

Would it be possible to have some default content appear in the post editor for all of the code reference pages? I imagine it working something like this:

1. Default content with outline appears in post editor (does not appear on the front end)
2. Admin fills in the outline
3. Published to the front end

This would make sure that all editors have immediate access to the documentation.

[DrewAPicture]

Yes. We could filter on the ​the_editor_content hook to inject some default content into the editor if no content is present.

[mfalhi_155]

Replying to siobhan:

To ensure that curated explanations in the code reference are consistent we need some sort of style guide.

This should be created and posted to the docs handbook. It should be linked to from the admin screen in the code reference.

See: ​http://irclogs.wordpress.org/chanlog.php?channel=wordpress-sfd&day=2014-09-09&sort=asc#m134058

[obenland]

@DrewAPicture Is there a plan for moving this forward or should we close it for now?

[coffee2code]

Closing for now.

As Drew ​said in Slack a month ago:

Yes, we should probably have some kind of guide, but right now it’s sort of “use common sense with headings to ensure a proper table of contents gets generated” and “make sure to use syntax highlighting around any code".