Skip to content

Ideas of splitting up the README #212

@EdJoPaTo

Description

@EdJoPaTo

Is your feature request related to a problem? Please describe.

The README is getting longer and longer and scrolling in it seems not a well-structured approach.

Also, there are some "basic" editors and some more advanced which are easier to understand once the more basic ones are known. For example css_remove is really obvious after css_select is known. Same with css_flatten and css_remove. But their alphabetic order is exactly opposite.

Having them split up would allow them to be added to the given editor in code too. Additionally, it would be neat to check the editor configuration for correctness with tests. But that's likely too much of an overhead given that they should still be readable as plain Markdown.

Describe the solution you'd like

Split them up into a docs/editors/name.md structure

Describe alternatives you've considered

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions