Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

consolidated: screenshot audit and refresh program

Ouverte
#191 69 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
20/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github, markdown
Domaine
documentation

Piste de recherche

Treat this as the program tracker; implementation is assigned to child issues #65–#77 and #84–#96, with #85 checking reusable orphan assets before recaptures. Start by reading the relevant child issue and its named documentation page and image paths, then follow the capture standards in this issue. Done means the child work meets its acceptance criteria and has a PR; this tracker covers a repository-wide program and is not a suitable standalone first contribution.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

auto-dispatch consolidated documentation enhancement help wanted origin:worker status:blocked tier:standard

Supersedes #64 — this issue is the consolidated spec.

What

Run the repository-wide Screenshot Audit and Refresh Program. Every documentation screenshot must depict the UI described beside it, be unique to that concept, tightly cropped to the relevant control, readable, and optimized for the documentation site. Deliver the work through the already-filed child issues; retain this issue as the program tracker.

Program inventory and delivery structure
  • The English docs currently track 147 image files, reference 98 unique image paths, and include at least 32 byte-identical duplicate files.
  • Existing focused children remain the implementation queue: #65 Zapier, #66 Stripe, #67 PayPal, #68 customer account, #69 product limitation tabs, #70 network dashboard widgets, #71 payment tabs, #72 checkout editor, #73 registration form (after #72), #74 webhooks, #75 installation wizard, #76 analytics dashboard, #77 site templates.
  • The second audit added children #84 (28 addon index.mdx pages with no screenshots), #85 (48 unreferenced static/img/ files; examine reusable captures before recapturing), and #86–#96 for the gap pages listed in How.
  • Keep #64 as the historical source, but use this issue as the single current specification. Issues #78–#83 were duplicate section programs and remain superseded; do not reopen them.
  • Lower-priority, not-yet-filed work: re-capture the populated-list states in docs/user-guide/administration/touring-the-admin-panel.md and docs/user-guide/administration/managing-memberships.md with seed data.

Why

The audit found screenshots reused for unrelated concepts, including walkthroughs where one placeholder illustrates every step. This makes instructions misleading, conceals current product UI, and adds unnecessary static assets. The program replaces placeholders with accurate shots, wires in useful orphan captures before taking new ones, and keeps images fast and consistent.

How

Capture and asset standards
Requirement Standard
Capture viewport 1280 × 800 at device-pixel-ratio 1 and browser zoom 100%
Admin appearance Default WordPress admin colour scheme; no admin-bar customisation
Format 8-bit RGB, non-interlaced PNG
Size Longest edge no more than 1568 px; normally target under 200 KB
Readability Text remains at least 12 px after cropping
Crop Tight panel/section crop; include WordPress chrome only when the docs discuss it
Annotation None unless the existing documentation requires it
Naming Preserve replacement names; new captures use kebab-case-area-element.png under the matching static/img/admin/, static/img/config/, or static/img/installation/ directory
Optimization Run pngquant --quality=70-90 --skip-if-larger -f -o out.png in.png or oxipng -o 4 in.png before commit

Capture against the current Ultimate Multisite main build in the authorized local WordPress environment. Use authorized credentials without recording them in commits, comments, screenshots, or issues. Standard tools include Flameshot/GNOME Screenshot, macOS Screenshot, or a headed Playwright/Chromium window configured to the capture viewport. Rename macOS screenshots to ASCII before committing; the default name can contain a narrow no-break space. Do not retain default Screenshot … AM/PM.png names.

Per-child workflow
  1. Re-create or open the screen described by the target documentation text.
  2. Capture to the exact existing asset path, or add the narrowly named new asset path stated by the child issue.
  3. For a split walkthrough, update the listed Markdown/MDX references to the new per-step captures.
  4. Optimize the image, run npm start, visit the target documentation page, and verify every image renders and matches the adjacent text.
  5. Commit with docs(screenshots): refresh <area> per issue #<N> and open a PR for the child issue.
Audit findings and assigned children
Exact duplicate asset groups

The following MD5-equal groups must become concept-specific captures through their assigned children:

Duplicate group Paths Child
9 product limitation tabs static/img/config/product-{custom-domains,disk-space,hide-credits,plugins,post-types,reset-limitations,site-templates,themes,upgrades}.png (28,236 B each) #69
7 dashboard views static/img/admin/network-dashboard-{activity-stream,first-steps,full,news,right-now,summary}.png, static/img/installation/network-dashboard.png (125,540 B each) #70
3 payment settings shots static/img/admin/settings-payments-{bottom,gateways-2,options}.png #71
2 period-selection views static/img/config/period-selection-field-{options,settings}.png #72
2 installation shots static/img/installation/plugin-activated.png, static/img/installation/wizard-welcome.png #75
2 dashboard shots static/img/admin/um-dashboard-bottom.png, static/img/admin/um-dashboard-stats.png #76
Placeholder walkthroughs already covered
  • #65: docs/user-guide/integrations/zapier.md has 14 distinct Zapier concepts but uses webhooks-list.png; it needs the dashboard, app search, trigger picker, auth, Ultimate Multisite API settings, credentials, payment_received, test step, action setup, and the other described steps.
  • #66: docs/user-guide/payment-gateways/stripe.md has 13 concepts but repeatedly uses settings-payment-gateways.png; cover active gateways, inline card, Checkout redirect, keys, Stripe dashboard, test data, webhooks, listener URL, and endpoint setup.
  • #67: docs/user-guide/payment-gateways/paypal.md has 5 concepts but reuses the payment settings image for PayPal-side steps.
  • #68: docs/user-guide/client-management/account-page.md has 16 customer-facing account concepts but reuses network-admin images. Cover account menu/overview, plan, limits, billing, profile update, template switching, domain/DNS flow, password, and Danger Zone.
  • #74: replace the heavy /img/admin/webhooks-list.png placeholder reuse in the Zapier registration/webhook flow.
High-reuse images and the corresponding program work

/img/admin/webhooks-list.png is referenced 35 times (#65, #74); /img/config/settings-payment-gateways.png 34 times (#66, #67); /img/admin/memberships-list.png 17 times; /img/config/checkout-form-step.png 16 times (#72, #73); /img/config/settings-taxes.png 15 times; and /img/config/discount-codes-list.png 14 times. The last four are resolved by the child issues below or future focused work, not by a blanket asset replacement.

Gap-page children from the second audit

Use these exact page-level findings when executing #86–#96. The line references were recorded on the audit revision; verify current context before editing.

Child Documentation file Required distinct captures
#86 docs/user-guide/payment-gateways/getting-paid.md Replace 18 placeholders: settings-payment-gateways.png at L16,22,26,30,34,36,42 for payment rows/toggles/invoice settings, and settings-general.png at L62,66,70,74,78,86,90,94,102,106,110 for WooCommerce, GoCardless, and Payfast install dialogs.
#87 docs/user-guide/payment-gateways/manual-payments.md Replace three settings-payment-gateways.png uses (manual toggle, frontend instructions, Thank You page) and three payments-list.png uses (list, detail, status change/activate-membership). Check reusable orphans before recapture.
#88 docs/user-guide/payment-gateways/tax-handling.md Replace 15 settings-taxes.png uses (L18,26,38,42,52,54,58,60,80,84,86,90,94,102,110): tax toggles/rates/categories, VAT add-on install and activation, VAT support, EU rate pull, and frontend VAT field.
#89 docs/user-guide/configuration/creating-discount-codes.md Replace 14 discount-codes-list.png uses (L16,22,24,28,36,40,44,50,54,64,66,70,74,78). First assess and wire accurate orphan assets discount-code-edit.png, discount-code-active.png, discount-code-advanced.png, discount-code-description.png, discount-code-save.png, and discount-codes-empty.png.
#90 docs/user-guide/configuration/the-registration-flow.md Replace 9 uses across checkout-forms-list.png (L20), checkout-form-editor.png (L26,32), settings-payment-gateways.png (L46,50,54), and payments-list.png (L60,64,66,70); include customer registration, Thank You page, activation, manual payment, and admin payment processing.
#91 docs/user-guide/client-management/upgrading-a-plan.md Replace 5 memberships-list.png placeholders (customer account, membership change, plan checkout, upgrade summary, no-change state) and 3 product-upgrades.png placeholders (admin up/downgrades and plan-group assignment).
#92 docs/user-guide/client-management/canceling-a-membership.md Replace 6 memberships-list.png usages (L16,20,24,26,30; two images on L30) with customer Danger Zone, confirmation, logged-out, cancellation, and retained-customer states.
#93 docs/user-guide/client-management/downgrading-a-plan.md Replace 3 memberships-list.png shots (change control, plans, pending-change) and settings-sites.png (post-limit options).
#94 docs/user-guide/client-management/client-websites.md Replace 6 customers-list.png shots (L12,18,22,26,30,34) with customer My Sites, account menu, default-site selection, dropdown, and confirmation.
#95 docs/user-guide/domain-mapping/how-to-configure-domain-mapping.md Replace 7 settings-domain-mapping.png and 9 domains-list.png placeholders: sunrise wizard, mapping controls, redirects/user access, product custom-domain choice, integration/hosting, domains list/add modal/transitions/detail, and subsite controls.
#96 docs/user-guide/miscellaneous/sending-emails-and-broadcasts.md Replace 9 broadcasts-list.png uses (customer notice, menu, add modal as message/email, targeting, editor) and 5 settings-emails.png uses (Emails settings, customization, reset/import/options).
Additional program scope and decisions
  • #84 owns the 28 addon index pages with no screenshots.
  • #85 owns the 48 orphan static images; use accurate existing images before creating replacements, particularly for #89, #95, and #87.
  • Future focused issues may cover VAT/tax, discount codes, domain mapping, WooCommerce, GoCardless, PayFast, Language Selector, Site Exporter, Admin Page Creator, and administration-tour refreshes when not already covered above.
  • Do not reopen #78 (duplicate master), #79 (covered by #65/#74), #80 (covered by #66/#67/#71 and #86–#88), #81 (covered by #69/#72/#73/#77 and #89/#90), #82 (covered by #68 and #91–#94), or #83 (covered by #95/#96 plus the future list-state refresh).
Audit reproducibility

Use the following checks when reassessing a target area:

git ls-files | grep -iE '\.(png|jpg|jpeg|gif|webp)$'
find static/img -type f -name '*.png' -exec md5sum {} \; | sort | uniq -d -w 32
grep -rohE '/img/[^)" ]+\.png' docs/ | sort | uniq -c | sort -rn
find static/img -name '*.png' -exec file {} \;

Acceptance Criteria

  • Each child issue has an accurate, per-concept capture plan; no implementation PR reuses a known placeholder image for a materially different UI state.
  • New/replaced screenshots meet the capture standards, optimize their PNGs, and render correctly in the relevant documentation page.
  • The duplicate groups and per-page placeholder work are completed only through their focused child issues, with #85 assessed before recapturing candidate orphan assets.
  • The screenshot program retains the documented child-issue coverage and does not reopen superseded duplicate programs #78–#83.
  • The two populated-list refresh pages remain explicitly deferred until separately filed.

Context & Decisions

  • Original audit / #64: established the asset counts, duplicate groups, capture standards, child #65–#77 queue, and original future-work candidates. Its core decision was one focused issue per screenshot area rather than a monolithic asset change.
  • @superdav42, Comment 1: reported a parallel duplicate audit (#78/#79/#80), added the zero-screenshot addon and orphan-file categories, and recommended retaining the #64 program with focused children rather than parallel section trackers.
  • @superdav42, Comment 2: reconciled the two methodologies, recorded 11 additional placeholder-reuse pages and two data-state pages, retained #84/#85 as net-new issues, and confirmed #78–#83 were duplicates.
  • @superdav42, Comment 3: confirmed that the 11 gap pages were filed as #86–#96 and supplied the complete index tying every affected page to its focused child. This supersedes the earlier proposal to create those children.
  • Final agreed approach: this single issue is the program specification; execute focused children, reuse accurate orphan assets where possible, and keep capture operations reproducible and optimized.

Contributors

cc @superdav42

Files Scope

Hard boundaries: This is a coordination tracker. It authorizes no direct repository-file changes; source and asset edits belong only to the explicitly linked child issues.

AI brief owner: Pulse consolidation workflow.


aidevops.sh v3.34.13 plugin for OpenCode v1.18.31 with gpt-5.6-terra

Langage dominant
MDX
Étoiles
0
Forks
0
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Ultimate-Multisite/docs

Toutes les issues de Ultimate-Multisite/docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.