Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Docs for to-do list feature #132

Merged
merged 4 commits into from
Aug 8, 2019
Merged

Docs for to-do list feature #132

merged 4 commits into from
Aug 8, 2019

Conversation

pjasiun
Copy link

@pjasiun pjasiun commented Aug 6, 2019

Suggested merge commit message (convention)

Docs: Docs for to-do list feature. Part of ckeditor/ckeditor5#1434.


Additional information

Docs need to be updated when the feature will be ready:

  • links to the API need to be added,
  • live demo need to be updated.

@Reinmar Reinmar self-assigned this Aug 8, 2019
@Reinmar
Copy link
Member

Reinmar commented Aug 8, 2019

Just to be sure – what's the source of that waffles image and what's its license?

@pjasiun
Copy link
Author

pjasiun commented Aug 8, 2019

It was taken from the free images stock (https://www.pexels.com/search/waffles/) and it is free to use (https://www.pexels.com/photo-license/).

@Reinmar
Copy link
Member

Reinmar commented Aug 8, 2019

I started wondering – should we have a separate guide for the list feature?

If yes, then there will be a "Lists" position in the left menu. Should the todo list feature guide be merged into it? Or should it be kept separately?

@Reinmar
Copy link
Member

Reinmar commented Aug 8, 2019

If yes, then there will be a "Lists" position in the left menu. Should the todo list feature guide be merged into it? Or should it be kept separately?

Actually, I wanted to answer this myself – I'd keep it separately becasue while normal lists are part of all builds, this feature will not be. Also, it's quite "special" and it's better to increase its visibility by extracting it to a separate guide.

This means that we don't need to work now on a generic "Lists" feature guide, because it will be completely separate from the currently proposed "To-do lists" guide.

@Reinmar
Copy link
Member

Reinmar commented Aug 8, 2019

The PR LGTM. I'll merge it but once the implementation of the feature lands we'll have to do some minor tweaks like:

  • Link to TodoList plugin whenever the class is mentioned.
  • Add "Common API" section (as in other guides).

@pjasiun
Copy link
Author

pjasiun commented Aug 8, 2019

I think we should have a separate list feature guide. But I also think it should be separate. I believe that from the end-user perspective these are two separate features. Todo lists do not make sense in many cases (for instance document editor). Also, when you think about use cases for to-do lists, they are different than use cases for lists.

@Reinmar Reinmar merged commit 5fa6ddd into master Aug 8, 2019
@Reinmar Reinmar deleted the t/ckeditor5/1434-docs branch August 8, 2019 08:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants