WordPress.org

Making WordPress.org

Opened 5 years ago

Closed 11 months ago

#602 closed enhancement (maybelater)

Curated explanations require a style guide

Reported by: siobhan Owned by: DrewAPicture
Milestone: Priority: normal
Component: Developer Hub Keywords:
Cc:

Description

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

Change History (12)

#1 @siobhan
5 years ago

  • Owner set to siobhan
  • Status changed from new to assigned

#2 @siobhan
5 years ago

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.

#3 @DrewAPicture
5 years ago

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

This ticket was mentioned in Slack in #meta-devhub by drew. View the logs.


3 years ago

#5 @DrewAPicture
3 years ago

  • Owner changed from siobhan to DrewAPicture
  • Priority changed from normal to high

#6 in reply to: ↑ description @mfalhi_155
3 years ago

  • Milestone set to Plugin Directory v3 - M1
  • Priority changed from high to normal

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

#7 @samuelsidler
3 years ago

  • Milestone Plugin Directory v3 - M1 deleted
  • Priority changed from normal to high

This ticket was mentioned in Slack in #meta by obenland. View the logs.


15 months ago

#9 @obenland
15 months ago

  • Type changed from defect to enhancement

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

#10 @DrewAPicture
12 months ago

  • Priority changed from high to normal

This ticket was mentioned in Slack in #meta-devhub by drew. View the logs.


12 months ago

#12 @coffee2code
11 months ago

  • Resolution set to maybelater
  • Status changed from assigned to closed

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".

Note: See TracTickets for help on using tickets.