Skip to content

Docs rework #2844

Open
Open
@asvae

Description

@asvae

User story

As a user, vuestic documentation is not great for me:

  • examples are too prop specifics and don't look good;
  • text is too technical and sometimes states the obvious;
  • documentation is failing some accessibility checks.

Solution broad

All of these points we can definitely improve by:

  • using more scenic examples that portray real case instead of showing how to use some particular prop;
  • imroving text by adding some broader information (again, based off user case instead of component functionality);
  • fixing accessibility issues and applying automated checks.

Solution steps

Documentation rework:

Accesibility improvements:

Other

Timeline

  • Plan is to include some changes in 1.6.0 if possible, but this would be ongoing effort through 1.7.0 and probably even further.

Metadata

Metadata

Labels

docspackages/docsepicFeature that is too big to fit in one issueresearchRequires research

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions