-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Improve feature discoverability in the documentation #5703
Comments
cc @panr |
How are we doing with the "new" / "extended" flag for the guides? This would also help draw attention to some features. |
I allowed myself to change the propose feature guide structure reflecting changes that are already introduced into a large number of the guides. |
We should revisit the #5588 idea for "all-features editor" (as far as this is available, OFC) and decide whether we put it in examples or on the features landing page. |
Also, this is a rather new implementation and an approach we should consider. This is the online html editor user-guide, which is user oriented, without any developer stuff: https://onlinehtmleditor.dev/user-guides/real-time-collaboration-editor/ We may consider expanding all docs with this kind of approach of: an introduction (existing) - user guide (to do) - developer info (existing) scheme, which would make it:
It would be a massive task, but parts of these are already written if we repurpose the existing guide and anyway this does not need to be a mammoth update, but can be introduced gradually (and also during other commits, as well). Your opinions welcome. The job is partly done anyway for other purpose, so you can see and test it in real-life scenario (please disregard the CKE4 editor, tho). |
This epic is about improving the Features guides to make them:
Proposed feature guide structure
TODO
This is a huge task and it will not be covered in one iteration. Some sub-tasks that could be a part of this epic:
The text was updated successfully, but these errors were encountered: