New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User Handbook #11252

chrisvanpatten opened this Issue Oct 30, 2018 · 3 comments



chrisvanpatten commented Oct 30, 2018

This is a tracking ticket for the User Handbook. The goal is to use this ticket to get us to…

  1. Consolidate discussion
  2. Consolidate GitHub issues related to the user documentation into this ticket
  3. Map PRs to sections of the handbook outline

This is the documentation outline that needs the most love and attention. I expect our documentation bug scrubs will flesh it out, but please feel free to comment with more ideas!


  1. Meet the editor (high level UI overview)
    1. What is a block?
    2. Customising blocks
    3. Reusable blocks
    4. Plugins (how to find/access)
  2. Manual for users of assistive technologies (#10373)
  3. FAQ
    1. How do I stick with Classic?
    2. What do I need to know about backwards compatibility?
    3. What's different about the new editor? (#4186)
    4. Where do I report problems?

This comment has been minimized.


0aveRyan commented Oct 30, 2018

Some basics that we're all probably used to it'd be great to spell out:

  • All Paragraphs are their own Blocks
  • Blocks can be converted into related Blocks
  • There is a Classic Block for a familiar experience
  • Saving posts no longer reloads the page

Some additional topics that'd be great to include for users:

  • Using the Document Outline
  • How the Sidebar Works (Show/Hide, Contextual, Document vs. Block, Plugins)
  • Setting Editor Preferences via the Menu
  • Using Editor Plugins

Some "hidden" features it'd be great to highlight:

  • Terrific Copy/Paste support
  • Using the Slash Inserter
  • Using Keyboard Shortcuts
  • Copy a URL, highlight text and paste to create a hyperlink from the selection

This comment has been minimized.


0aveRyan commented Nov 14, 2018

Took another pass at this outline as well @chrisvanpatten

  1. Introducing the New Editor
  2. Creating & Managing Content
    1. Getting Started
    2. Quick Start
    3. Introducing Blocks
      1. Getting Started
      2. Insert Blocks
      3. Customize Blocks with the Toolbar & Sidebar
      4. Rearrange, Duplicate or Delete Blocks
      5. Transform Blocks
      6. Choose Block Styles
      7. Block Reference
    4. Introducing Reusable Blocks
      1. Getting Started
      2. Convert to Reusable Block
      3. Convert to Regular Block
      4. Manage & Delete Reusable Blocks
    5. Working with Templates
  3. Personalize Your Editing Experience
    1. Using Spotlight Mode
    2. Using Fullscreen Mode
    3. Using Unified Toolbar Mode
    4. Using Custom Editor Plugins
  4. Common Questions
    1. How do I keep the Classic Editor?
    2. Will this break my website? Is it compatible with old content?
    3. What’s new?
    4. I’m struggling with the New Editor, any tips?
    5. Where do I report problems?
    6. What should I expect going forward?
  5. Reference
    1. Editor Diagram (labeled)
    2. Additional Resources
  6. Help & Support

This comment has been minimized.


chrisvanpatten commented Nov 14, 2018

@0aveRyan this is KILLER. It would be awesome to get some volunteers in here to pick a section or document and start writing. Is that something you want to kick-off?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment