Bundle documentation templates
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Ambito
- content, documentation, web-dev
Direzione di ricerca
La issue propone un plugin separato che registri tipi di contenuto per la documentazione e fornisca un’esperienza compatibile con i themes pronta all’uso, traendo spunto dalle tecniche di bbPress/BuddyPress. Non vengono indicati file, test o punti di ingresso; inizia individuando l’importer e i tipi di contenuto registrati, quindi definisci l’ambito del plugin e l’approccio alla compatibilità prima dell’implementazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- PHP
- Stelle
- 239
- Fork
- 81
- Merge medio
- 1g 22h
- PR unite (30g)
- 5
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di WordPress/phpdoc-parser
-
Include constants in exportsAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
WordPress/phpdoc-parser#269 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 64/100
WordPress/phpdoc-parser#268 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
WordPress/phpdoc-parser#254 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
WordPress/phpdoc-parser#246 · 9 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
WordPress/phpdoc-parser#235 · 1 commento ·
Tutte le issue di WordPress/phpdoc-parser
Issue simili
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 3 giorni
-
Перевод устарел
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
-
Form
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
symfony/symfony-docs#23159 ·
I maintainer di solito rispondono entro 3 giorni
-
bug component: bulk editor support
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Yoast/wordpress-seo#23669 ·
I maintainer di solito rispondono entro 3 giorni