Skip to content

rename basic examples' filename and component tag name #3961

@Kiarokh

Description

@Kiarokh

There is a documentation convention, which we poorly follow across the library:

  • the first example for each component is always the "basic" example, with no props set, explaining the very basic functionality of the component.
  • both the filename and tag name should be suffixed by -basic

This will for example help, when developers are trying to find the component and when they press Cmd+P and type the component name. Having an example file, which as the same name as the component file itself makes it irritating. Sometimes you open that, then realize you have to close it and do this all over again, or click a few more times to reach the file you actually wanted to open.

  • we also don't follow having a consistent heading for all basic examples. Sometimes they have a particular heading (which is OK), but sometimes the might have a heading (first docs line) of Basic or Basic example or other things.

@adrianschmidt-bot please make a PR, where:

  • where you find and rename all first examples that have the same filename as the component itself
  • update filename and tag names
  • update headings if necessary, and if they are particularly not describing something (e.g. Don't reword the heading of the first limel-badge example
  • Commit each component's renamed example separately so it becomes easier for humans to review.
  • If you find other basic examples where headings are missing or inconsistent (filename might be correct), please fix them too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation that's missing or needs improvementreleased

    Type

    No type

    Projects

    Status

    ⚡️

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions