wagtail / wagtail/guide

☂️ Feature documentation gaps

Open
#398 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
Python
Stars
36
Forks
39
Avg merge
2d 5h
Merged PRs (30d)
3

Description

This is tracking issue of all feature documentation gaps, in particular to meet the ATAG 2.0 A.4.2.2 Document All Features guideline:

For each authoring tool feature, at least one of the following is true: (Level AA)
a. Described in the Documentation: Use of the feature is explained in the authoring tool's documentation

To meet this ATAG requirement, it’s also possible to have documentation directly within the interface (like help text), among other options. But I think it makes sense for all features to be documented in our guide website regardless of that. Here are known gaps as of Wagtail 6.3:

  • Global
    • Skip link
    • No-JS warning message
    • Sidebar
    • Header
    • Messages
    • Relative date
    • Status tag
    • Table listing
    • Pagination
    • Dashboard
    • Unauthorized access (403)
    • Page not found (404)
    • Accessibility checker #303
    • Wagtail userbar #303
  • Pages
    • Pages explorer
    • Add child page
    • Page type usage
    • Privacy
    • Move pages #334
    • Promote fields #336
    • Copy
    • Delete
    • Publish
    • Unpublish
    • View all revisions
    • Compare revisions
    • Review revision
    • Create
    • Edit
    • Edit - Promote tab
    • Preview #325
    • Accessibility checker #388
    • Scheduled publishing
    • Explorer - Bulk actions
    • Explorer - Bulk move
    • Explorer - Bulk delete
    • Explorer - Bulk publish
    • Explorer - Bulk unpublish
    • Explorer - View child pages
    • Explorer - View child pages - Reorder child pages #307
    • Explorer - View child pages - Sort by column
    • Explorer - Root level
    • Search
    • Search - Filtered
  • Images
    • View all
    • Search
    • Search - Filtered
    • Edit
    • Add an image #363
    • Add multiple images
    • Delete
    • Image URL generator #386
    • Bulk actions
    • Bulk add tags
    • Bulk add to collection
    • Bulk add delete
  • Documents
    • View all
    • Search
    • Search - Filtered
    • Edit
    • Add a document
    • Add multiple documents
    • Delete
    • Bulk actions
    • Bulk add tags
    • Bulk add to collection
    • Bulk add delete
  • Snippets
    • View all types
    • View all
    • Search snippets
    • Edit
    • Add
    • Delete
    • Bulk delete
    • Publish
    • Unpublish
    • Preview
    • Scheduled publishing
    • View all revisions
    • Compare revisions
    • Review revision
  • Forms
    • View all
    • View submissions
  • Reports
    • Locked Pages
    • Workflows
    • Workflow tasks
    • Site history
    • Aging pages
    • Page types usage
  • Workflows
    • View all
    • Add
    • Usage
    • Edit
  • Workflow tasks
    • View all
    • Add
    • Edit
    • Disable
  • Users
    • View all
    • Search
    • Edit
    • Edit - Edit roles
    • Add
    • Add - Add roles
    • Delete
    • Bulk actions
    • Bulk delete
    • Bulk set active state
    • Bulk assign role
  • Groups: #98
    • View all
    • Search
    • Add a group
    • Edit
    • Delete
    • Group users
  • Sites
    • View all
    • Edit
    • Add a site
    • Delete
  • Locales
    • View all
    • Edit
    • Add a locale
    • Delete
  • Collections
    • View all
    • Edit
    • Add a collection
    • Privacy
  • Redirects
    • View all
    • Search
    • Import redirects
    • Add
    • Export Redirects
    • Edit
    • Delete
  • Promoted search
    • View all
    • Search
    • Edit
    • Add results
    • Delete
  • User account
    • Account profile
    • Account notifications
  • Styleguide
    • Styleguide
  • Auth
    • Login
    • Password reset
    • Password reset done

Contributor guide

Open the contributing guide

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

Use the unchecked-feature checklist as the scope map and select a single documentation gap rather than attempting the whole tracking issue. Start from the relevant feature entry in the guide website; done means its usage is documented and the corresponding checklist item can be marked complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.