WordPress / WordPress/phpdoc-parser

Bundle documentation templates

Open
#14 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Someday Maybe
Dominant language
PHP
Stars
239
Forks
81
Avg merge
16h 29m
Merged PRs (30d)
8

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
php, wordpress
Domain
content, documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.