WordPress.org

Making WordPress.org

Opened 6 years ago

Last modified 8 weeks ago

#215 new enhancement

Feature Request: Readme.txt generated tabs on theme pages

Reported by: iandstewart Owned by:
Milestone: Priority: high
Component: Theme Directory Keywords: dev-feedback needs-testing
Cc:

Description

Like plugins it'd be really cool to have readme.txt-generated tabs on theme pages. Maybe taking over from style.css descriptions? As themes get more complicated this can really help users better understand how to use them and find support. Even for uncomplicated themes it can still be useful. Like, say, if the theme uses post formats, it's a great place to describe them.

I think I've seen this mentioned somewhere before but I couldn't find a ticket.

Change History (42)

#1 @zoonini
6 years ago

  • Cc zoonini@… added

#2 @nacin
6 years ago

One possible blocker: We don't actually have a formal, accepted theme readme.txt standard.

#3 @designsimply
6 years ago

  • Cc designsimply added

#4 follow-up: @chipbennett
6 years ago

Perhaps start from the Plugin readme standard, and then work from there?

This is a much-needed feature, that would be really useful.

#5 in reply to: ↑ 4 @cais
6 years ago

Replying to nacin:

One possible blocker: We don't actually have a formal, accepted theme readme.txt standard.

Replying to chipbennett:

Perhaps start from the Plugin readme standard, and then work from there?

This is a much-needed feature, that would be really useful.

As suggested by Chip here, we (WPTRT) have been suggesting to follow the WordPress Plugin readme.txt format for quite some time now. No reason not to start there would be my opinion as well.

I actually use the Plugin Readme Validator to view my themes' readme.txt files all the time just to see how they would be parsed with a similar system.

#6 @emiluzelac
6 years ago

  • Cc emiluzelac added

Extremely useful and very much needed :)

#7 @chipbennett
6 years ago

  • Cc chipbennett added

#8 @greenshady
6 years ago

  • Cc greenshady added

#9 @jcastaneda
6 years ago

  • Cc jcastaneda added

#10 @tskk
6 years ago

  • Cc tskk added

#11 @mercime
6 years ago

  • Cc mercijavier@… added

#12 @Frumph
6 years ago

  • Cc Frumph added

#13 @estoeckel
6 years ago

  • Cc estoeckel added

#14 @Frank Klein
6 years ago

  • Cc contact@… added

#15 @richardmtl
6 years ago

  • Cc richardmtl added

#16 @siobhyb
6 years ago

  • Cc siobhanbamber@… added

#17 @kwight
6 years ago

  • Cc kwight added

This ticket was mentioned in Slack in #themereview by greenshady. View the logs.


5 years ago

#19 @emiluzelac
5 years ago

  • Cc emiluzelac removed

#20 @emiluzelac
5 years ago

  • Cc emil@… added

#21 @ramiy
5 years ago

  • Cc r_a_m_i@… added

#22 @ZGani
5 years ago

  • Cc zulfikarnore@… added

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


5 years ago

This ticket was mentioned in Slack in #themereview by greenshady. View the logs.


5 years ago

This ticket was mentioned in Slack in #themereview by melchoyce. View the logs.


4 years ago

#26 @colorful tones
4 years ago

  • Cc damonacook@… added

This ticket was mentioned in Slack in #themereview by greenshady. View the logs.


15 months ago

#28 @DannyCooper
15 months ago

+1 - The biggest concern to authors right now is that they can't display their themes in the best light due to restrictive screenshot and preview guidelines. Multiple screenshots like the plugin directory has would solve this.

What's the best way to move this ticket forward? The plugin directory already has a working (superior) solution.

This ticket was mentioned in Slack in #themereview by dannycooper. View the logs.


15 months ago

#30 @Air.
15 months ago

I don't know if the number of replies matter, but this was very strange for me that something(readme.txt) working so well for plugins is not done for themes, while they, in theory, have same possibilities as plugins.

That is also one of many reasons why releasing plugins and themes on wordpress.org are SOO different experiences(with a big advantage for plugins).

+1 for readme.txt support!

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


13 months ago

#32 @SergeyBiryukov
13 months ago

Last edited 13 months ago by SergeyBiryukov (previous) (diff)

This ticket was mentioned in Slack in #themereview by joyously. View the logs.


13 months ago

This ticket was mentioned in Slack in #themereview by joyously. View the logs.


13 months ago

This ticket was mentioned in Slack in #design by boemedia. View the logs.


13 months ago

#36 @dingo_d
5 months ago

  • Priority changed from normal to high

Since we already have the requirement for themes to implement valid readme like the plugins do (https://make.wordpress.org/themes/handbook/review/required/#readme-txt-file), there is no reason this shouldn't be implemented.

We discussed this on the WCEU and would like to move forward to unifying themes and plugin start page, give themes more versatility etc.

I'm not sure what is needed for this to happen, the thing that was needed from the TRT side is done (readme.txt required).
So if you can make some guide what needs to happen, some points where we can help that would be great :)

This ticket was mentioned in Slack in #themereview by dingo_d. View the logs.


5 months ago

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


4 months ago

This ticket was mentioned in Slack in #design by joyously. View the logs.


2 months ago

This ticket was mentioned in Slack in #themereview by joyously. View the logs.


8 weeks ago

#41 @dingo_d
8 weeks ago

  • Keywords dev-feedback needs-testing added

In order to use readme we need to be able to parse the readme data and store it in the theme meta data

  1. Parse readme data on theme being set live (approved)
  2. Store parsed data to theme meta data
  3. Use that to display the data
  4. Style it as plugins
  5. Celebrate

@williampatton mentioned that he'd look into parsing the data and we can work off of that.

#42 @dd32
8 weeks ago

This ticket is really pending design for WordPress.org and Core - Parsing the readme's is pointless if there's nowhere reasonable or a decent way to display it.

If the intention is to redesign the entire page, to be similar to plugins rather than what it currently is, lets get some focused work on that first.

Note: See TracTickets for help on using tickets.