Separate guides: editor, developer, plugin

[texnixe]

• Developer Guide
• Editor Guide
• Plugin Guide

[bastianallgeier]

Structure ideas for the editor guide:

• Installation
• Login
  • Login via email
  • Password reset
  • Blocked logins
• Site settings
  • Updating site info
  • Translating site info
  • Site files
• Pages
  • Pages sections
  • Creating pages
  • Publishing pages
  • Updating pages
  • Sorting pages
  • Deleting pages
  • Page files
  • Translating pages
• Files
  • Files sections
  • Uploading files
  • Replacing files
  • Updating file meta data
  • Translating file meta data
• User management
  • Create a new user
  • Change the password
  • Change the email address
  • Change the language
  • Change the role
  • Updating user info
  • Translating user info
  • User files
  • Deleting users
• Your account
  • Add your name
  • Change the password
  • Change the email address
  • Change the language
  • Change the role
  • Updating account info
  • Translating account info
  • Account files
  • Delete your account
• The system view
  • License registration
  • System information
  • Plugin list
• Language management
  • Creating languages
  • Primary vs secondary language
  • Updating languages
  • Deleting languages

[distantnative]

Plugin guide could be in the direction of:

• Getting started

• Setup

  • The basics
  • Autoloading
  • Composer dependencies
  • For Panel plugins

• Core

  • Class methods & models
  • Providing parts: Templates, Snippets, Blueprints, Routes..
  • Hooks
  • Core components
  • API

• Panel

  • Fields and Sections
  • Areas, Dialogs, Dropdown, Search
  • UI kit & CSS properties + selectors
  • Panel internals

• Enhance your plugin

  • Plugin options
  • Translating
  • Best practices

  Additional ideas

• "all the options" table or a document for 1.) PHP plugin declaration and 2.) JS plugin declarations. Something short like fields have, or longer like blueprints have

[lukasbestle]

Also related (developer docs): https://kirby.nolt.io/374

[distantnative]

@lukasbestle that seems more like a feature request (custom $kirby methods) than docs-related

[distantnative]

How would we want to do the menu structure? Separate menu entries or rather listing them all on the Guides menu entry?

The latter could look like this:

[lukasbestle]

@lukasbestle that seems more like a feature request (custom $kirby methods) than docs-related

The custom Kirby methods yes, but the custom components should already work.

[bastianallgeier]

How would we want to do the menu structure? Separate menu entries or rather listing them all on the Guides menu entry?

I would go for separate menu items. Helps to clean up the guide overview for beginners

[texnixe]

Yes, I prefer menu items as well.

[distantnative]

Not fully convinced tbh

neither this

[distantnative]

Maybe

[bastianallgeier]

I really like the version with the horizontal lines. We could even think about a bit more extended dropdown at some point.

[bastianallgeier]

No idea if it's really that good for our case, but something like Stripe is doing …

[distantnative]

Uh I like that

[distantnative]

Extending the dropdowns would allow us to list probably quite a few more items (e.g. Security) in there. Or also merge some top-level items

[distantnative]

I can't access the dropdowns for Stripe btw... when I try to move my cursor on the dropdown from the top-level item, the dropdown closes (Safari) 😂

[texnixe]

My 2ct: I think as long as we don't have more than those seven items max in the dropdown, a single column like now is actually easier to scan than multiple columns.