Bundle documentation templates
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- php, wordpress
- Domain
- content, documentation, web-dev
Research direction
The issue proposes a separate plugin that registers documentation post types and provides an out-of-the-box theme-compatible experience, drawing on bbPress/BuddyPress techniques. No files, tests, or entry points are named; begin by locating the importer and its registered post types, then define the plugin scope and compatibility approach before implementation.
Written by the indexing model from the issue text.
Description
I've been thinking about the problem of requiring people to build templates to display the data that this importer generates. Right now, it's not ideal:
- You have to register post types / taxonomies with the specific names that the importer uses.
- While it's a post type, you have to create template file for the single posts and archive templates, etc. While WP's template hierarchy will make things work with the default single.php template etc, this is almost certainly not going to be a decent experience for something as structured as the posts we create.
We could bundle template files with the plugin and tell users to copy into their theme, but as these will be full templates, we'll quickly find people complaining that the HTML/CSS structure is different from their themes' templates, and so on.
Proposal: create a plugin that registers the post types, and use bbPress/BuddyPress theme compatibility techniques to enable an out-of-the-box documentation experience for any site.
- Dominant language
- PHP
- Stars
- 239
- Forks
- 81
- Avg merge
- 16h 29m
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from WordPress/phpdoc-parser
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
WordPress/phpdoc-parser#269 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
WordPress/phpdoc-parser#268 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
WordPress/phpdoc-parser#254 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
WordPress/phpdoc-parser#246 · 9 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
WordPress/phpdoc-parser#235 · 1 comment ·
All issues in WordPress/phpdoc-parser
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
pluginsGLPI/datainjection#673 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
octobercms/october#6130 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
getgrav/grav-plugin-form#656 ·
-
customer-support needs-triage Platform(Default)
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100